com.google.cloud.discoveryengine.v1beta

Class SiteSearchEngineServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1beta.SiteSearchEngineServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class SiteSearchEngineServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing site search related resources.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   SiteSearchEngineName name =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
 }
 

Note: close() needs to be called on the SiteSearchEngineServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
GetSiteSearchEngine	Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSiteSearchEngine(GetSiteSearchEngineRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSiteSearchEngine(SiteSearchEngineName name) getSiteSearchEngine(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getSiteSearchEngineCallable()
CreateTargetSite	Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTargetSiteAsync(CreateTargetSiteRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createTargetSiteAsync(SiteSearchEngineName parent, TargetSite targetSite) createTargetSiteAsync(String parent, TargetSite targetSite) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTargetSiteOperationCallable() createTargetSiteCallable()
BatchCreateTargetSites	Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchCreateTargetSitesOperationCallable() batchCreateTargetSitesCallable()
GetTargetSite	Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTargetSite(GetTargetSiteRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTargetSite(TargetSiteName name) getTargetSite(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getTargetSiteCallable()
UpdateTargetSite	Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTargetSiteAsync(UpdateTargetSiteRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateTargetSiteAsync(TargetSite targetSite) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateTargetSiteOperationCallable() updateTargetSiteCallable()
DeleteTargetSite	Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTargetSiteAsync(DeleteTargetSiteRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteTargetSiteAsync(TargetSiteName name) deleteTargetSiteAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteTargetSiteOperationCallable() deleteTargetSiteCallable()
ListTargetSites	Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTargetSites(ListTargetSitesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTargetSites(SiteSearchEngineName parent) listTargetSites(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listTargetSitesPagedCallable() listTargetSitesCallable()
EnableAdvancedSiteSearch	Upgrade from basic site search to advanced site search.	Request object method variants only take one parameter, a request object, which must be constructed before the call. enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. enableAdvancedSiteSearchOperationCallable() enableAdvancedSiteSearchCallable()
DisableAdvancedSiteSearch	Downgrade from advanced site search to basic site search.	Request object method variants only take one parameter, a request object, which must be constructed before the call. disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. disableAdvancedSiteSearchOperationCallable() disableAdvancedSiteSearchCallable()
RecrawlUris	Request on-demand recrawl for a list of URIs.	Request object method variants only take one parameter, a request object, which must be constructed before the call. recrawlUrisAsync(RecrawlUrisRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. recrawlUrisOperationCallable() recrawlUrisCallable()
BatchVerifyTargetSites	Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchVerifyTargetSitesOperationCallable() batchVerifyTargetSitesCallable()
FetchDomainVerificationStatus	Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchDomainVerificationStatusPagedCallable() fetchDomainVerificationStatusCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of SiteSearchEngineServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
     SiteSearchEngineServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create(siteSearchEngineServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
     SiteSearchEngineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create(siteSearchEngineServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
     SiteSearchEngineServiceSettings.newHttpJsonBuilder().build();
 SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create(siteSearchEngineServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SiteSearchEngineServiceClient.FetchDomainVerificationStatusFixedSizeCollection
static class	SiteSearchEngineServiceClient.FetchDomainVerificationStatusPage
static class	SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse
static class	SiteSearchEngineServiceClient.ListTargetSitesFixedSizeCollection
static class	SiteSearchEngineServiceClient.ListTargetSitesPage
static class	SiteSearchEngineServiceClient.ListTargetSitesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SiteSearchEngineServiceClient(SiteSearchEngineServiceSettings settings) Constructs an instance of SiteSearchEngineServiceClient, using the given settings.
protected	SiteSearchEngineServiceClient(SiteSearchEngineServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
com.google.api.gax.longrunning.OperationFuture<BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata>	batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request) Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
com.google.api.gax.rpc.UnaryCallable<BatchCreateTargetSitesRequest,com.google.longrunning.Operation>	batchCreateTargetSitesCallable() Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
com.google.api.gax.rpc.OperationCallable<BatchCreateTargetSitesRequest,BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata>	batchCreateTargetSitesOperationCallable() Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
com.google.api.gax.longrunning.OperationFuture<BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata>	batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request) Verify target sites' ownership and validity.
com.google.api.gax.rpc.UnaryCallable<BatchVerifyTargetSitesRequest,com.google.longrunning.Operation>	batchVerifyTargetSitesCallable() Verify target sites' ownership and validity.
com.google.api.gax.rpc.OperationCallable<BatchVerifyTargetSitesRequest,BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata>	batchVerifyTargetSitesOperationCallable() Verify target sites' ownership and validity.
void	close()
static SiteSearchEngineServiceClient	create() Constructs an instance of SiteSearchEngineServiceClient with default settings.
static SiteSearchEngineServiceClient	create(SiteSearchEngineServiceSettings settings) Constructs an instance of SiteSearchEngineServiceClient, using the given settings.
static SiteSearchEngineServiceClient	create(SiteSearchEngineServiceStub stub) Constructs an instance of SiteSearchEngineServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<TargetSite,CreateTargetSiteMetadata>	createTargetSiteAsync(CreateTargetSiteRequest request) Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<TargetSite,CreateTargetSiteMetadata>	createTargetSiteAsync(SiteSearchEngineName parent, TargetSite targetSite) Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<TargetSite,CreateTargetSiteMetadata>	createTargetSiteAsync(String parent, TargetSite targetSite) Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.UnaryCallable<CreateTargetSiteRequest,com.google.longrunning.Operation>	createTargetSiteCallable() Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.OperationCallable<CreateTargetSiteRequest,TargetSite,CreateTargetSiteMetadata>	createTargetSiteOperationCallable() Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTargetSiteMetadata>	deleteTargetSiteAsync(DeleteTargetSiteRequest request) Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTargetSiteMetadata>	deleteTargetSiteAsync(String name) Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTargetSiteMetadata>	deleteTargetSiteAsync(TargetSiteName name) Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.UnaryCallable<DeleteTargetSiteRequest,com.google.longrunning.Operation>	deleteTargetSiteCallable() Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.OperationCallable<DeleteTargetSiteRequest,com.google.protobuf.Empty,DeleteTargetSiteMetadata>	deleteTargetSiteOperationCallable() Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata>	disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request) Downgrade from advanced site search to basic site search.
com.google.api.gax.rpc.UnaryCallable<DisableAdvancedSiteSearchRequest,com.google.longrunning.Operation>	disableAdvancedSiteSearchCallable() Downgrade from advanced site search to basic site search.
com.google.api.gax.rpc.OperationCallable<DisableAdvancedSiteSearchRequest,DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata>	disableAdvancedSiteSearchOperationCallable() Downgrade from advanced site search to basic site search.
com.google.api.gax.longrunning.OperationFuture<EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata>	enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request) Upgrade from basic site search to advanced site search.
com.google.api.gax.rpc.UnaryCallable<EnableAdvancedSiteSearchRequest,com.google.longrunning.Operation>	enableAdvancedSiteSearchCallable() Upgrade from basic site search to advanced site search.
com.google.api.gax.rpc.OperationCallable<EnableAdvancedSiteSearchRequest,EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata>	enableAdvancedSiteSearchOperationCallable() Upgrade from basic site search to advanced site search.
SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse	fetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request) Returns list of target sites with its domain verification status.
com.google.api.gax.rpc.UnaryCallable<FetchDomainVerificationStatusRequest,FetchDomainVerificationStatusResponse>	fetchDomainVerificationStatusCallable() Returns list of target sites with its domain verification status.
com.google.api.gax.rpc.UnaryCallable<FetchDomainVerificationStatusRequest,SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse>	fetchDomainVerificationStatusPagedCallable() Returns list of target sites with its domain verification status.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
SiteSearchEngineServiceSettings	getSettings()
SiteSearchEngine	getSiteSearchEngine(GetSiteSearchEngineRequest request) Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
SiteSearchEngine	getSiteSearchEngine(SiteSearchEngineName name) Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
SiteSearchEngine	getSiteSearchEngine(String name) Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
com.google.api.gax.rpc.UnaryCallable<GetSiteSearchEngineRequest,SiteSearchEngine>	getSiteSearchEngineCallable() Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
SiteSearchEngineServiceStub	getStub()
TargetSite	getTargetSite(GetTargetSiteRequest request) Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
TargetSite	getTargetSite(String name) Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
TargetSite	getTargetSite(TargetSiteName name) Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.UnaryCallable<GetTargetSiteRequest,TargetSite>	getTargetSiteCallable() Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
boolean	isShutdown()
boolean	isTerminated()
SiteSearchEngineServiceClient.ListTargetSitesPagedResponse	listTargetSites(ListTargetSitesRequest request) Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
SiteSearchEngineServiceClient.ListTargetSitesPagedResponse	listTargetSites(SiteSearchEngineName parent) Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
SiteSearchEngineServiceClient.ListTargetSitesPagedResponse	listTargetSites(String parent) Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
com.google.api.gax.rpc.UnaryCallable<ListTargetSitesRequest,ListTargetSitesResponse>	listTargetSitesCallable() Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
com.google.api.gax.rpc.UnaryCallable<ListTargetSitesRequest,SiteSearchEngineServiceClient.ListTargetSitesPagedResponse>	listTargetSitesPagedCallable() Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
com.google.api.gax.longrunning.OperationFuture<RecrawlUrisResponse,RecrawlUrisMetadata>	recrawlUrisAsync(RecrawlUrisRequest request) Request on-demand recrawl for a list of URIs.
com.google.api.gax.rpc.UnaryCallable<RecrawlUrisRequest,com.google.longrunning.Operation>	recrawlUrisCallable() Request on-demand recrawl for a list of URIs.
com.google.api.gax.rpc.OperationCallable<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata>	recrawlUrisOperationCallable() Request on-demand recrawl for a list of URIs.
void	shutdown()
void	shutdownNow()
com.google.api.gax.longrunning.OperationFuture<TargetSite,UpdateTargetSiteMetadata>	updateTargetSiteAsync(TargetSite targetSite) Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.longrunning.OperationFuture<TargetSite,UpdateTargetSiteMetadata>	updateTargetSiteAsync(UpdateTargetSiteRequest request) Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.UnaryCallable<UpdateTargetSiteRequest,com.google.longrunning.Operation>	updateTargetSiteCallable() Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
com.google.api.gax.rpc.OperationCallable<UpdateTargetSiteRequest,TargetSite,UpdateTargetSiteMetadata>	updateTargetSiteOperationCallable() Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteSearchEngineServiceClient

protected SiteSearchEngineServiceClient(SiteSearchEngineServiceSettings settings)
                                 throws IOException

Constructs an instance of SiteSearchEngineServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

SiteSearchEngineServiceClient

protected SiteSearchEngineServiceClient(SiteSearchEngineServiceStub stub)

Method Detail

create

public static final SiteSearchEngineServiceClient create()
                                                  throws IOException

Constructs an instance of SiteSearchEngineServiceClient with default settings.

Throws:

IOException

create

public static final SiteSearchEngineServiceClient create(SiteSearchEngineServiceSettings settings)
                                                  throws IOException

Constructs an instance of SiteSearchEngineServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final SiteSearchEngineServiceClient create(SiteSearchEngineServiceStub stub)

Constructs an instance of SiteSearchEngineServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SiteSearchEngineServiceSettings).

getSettings

public final SiteSearchEngineServiceSettings getSettings()

getStub

public SiteSearchEngineServiceStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getSiteSearchEngine

public final SiteSearchEngine getSiteSearchEngine(SiteSearchEngineName name)

Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   SiteSearchEngineName name =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
 }
 

Parameters:

name - Required. Resource name of [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSiteSearchEngine

public final SiteSearchEngine getSiteSearchEngine(String name)

Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   String name =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
 }
 

Parameters:

name - Required. Resource name of [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSiteSearchEngine

public final SiteSearchEngine getSiteSearchEngine(GetSiteSearchEngineRequest request)

Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   GetSiteSearchEngineRequest request =
       GetSiteSearchEngineRequest.newBuilder()
           .setName(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSiteSearchEngineCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSiteSearchEngineRequest,SiteSearchEngine> getSiteSearchEngineCallable()

Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   GetSiteSearchEngineRequest request =
       GetSiteSearchEngineRequest.newBuilder()
           .setName(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   ApiFuture<SiteSearchEngine> future =
       siteSearchEngineServiceClient.getSiteSearchEngineCallable().futureCall(request);
   // Do something.
   SiteSearchEngine response = future.get();
 }
 

createTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<TargetSite,CreateTargetSiteMetadata> createTargetSiteAsync(SiteSearchEngineName parent,
                                                                                                                       TargetSite targetSite)

Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   SiteSearchEngineName parent =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   TargetSite targetSite = TargetSite.newBuilder().build();
   TargetSite response =
       siteSearchEngineServiceClient.createTargetSiteAsync(parent, targetSite).get();
 }
 

Parameters:

parent - Required. Parent resource name of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

targetSite - Required. The [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<TargetSite,CreateTargetSiteMetadata> createTargetSiteAsync(String parent,
                                                                                                                       TargetSite targetSite)

Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   String parent =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   TargetSite targetSite = TargetSite.newBuilder().build();
   TargetSite response =
       siteSearchEngineServiceClient.createTargetSiteAsync(parent, targetSite).get();
 }
 

Parameters:

parent - Required. Parent resource name of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

targetSite - Required. The [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<TargetSite,CreateTargetSiteMetadata> createTargetSiteAsync(CreateTargetSiteRequest request)

Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   CreateTargetSiteRequest request =
       CreateTargetSiteRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setTargetSite(TargetSite.newBuilder().build())
           .build();
   TargetSite response = siteSearchEngineServiceClient.createTargetSiteAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTargetSiteOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateTargetSiteRequest,TargetSite,CreateTargetSiteMetadata> createTargetSiteOperationCallable()

Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   CreateTargetSiteRequest request =
       CreateTargetSiteRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setTargetSite(TargetSite.newBuilder().build())
           .build();
   OperationFuture<TargetSite, CreateTargetSiteMetadata> future =
       siteSearchEngineServiceClient.createTargetSiteOperationCallable().futureCall(request);
   // Do something.
   TargetSite response = future.get();
 }
 

createTargetSiteCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTargetSiteRequest,com.google.longrunning.Operation> createTargetSiteCallable()

Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   CreateTargetSiteRequest request =
       CreateTargetSiteRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setTargetSite(TargetSite.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.createTargetSiteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

batchCreateTargetSitesAsync

public final com.google.api.gax.longrunning.OperationFuture<BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata> batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request)

Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   BatchCreateTargetSitesRequest request =
       BatchCreateTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateTargetSiteRequest>())
           .build();
   BatchCreateTargetSitesResponse response =
       siteSearchEngineServiceClient.batchCreateTargetSitesAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateTargetSitesOperationCallable

public final com.google.api.gax.rpc.OperationCallable<BatchCreateTargetSitesRequest,BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata> batchCreateTargetSitesOperationCallable()

Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   BatchCreateTargetSitesRequest request =
       BatchCreateTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateTargetSiteRequest>())
           .build();
   OperationFuture<BatchCreateTargetSitesResponse, BatchCreateTargetSiteMetadata> future =
       siteSearchEngineServiceClient
           .batchCreateTargetSitesOperationCallable()
           .futureCall(request);
   // Do something.
   BatchCreateTargetSitesResponse response = future.get();
 }
 

batchCreateTargetSitesCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchCreateTargetSitesRequest,com.google.longrunning.Operation> batchCreateTargetSitesCallable()

Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   BatchCreateTargetSitesRequest request =
       BatchCreateTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllRequests(new ArrayList<CreateTargetSiteRequest>())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.batchCreateTargetSitesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getTargetSite

public final TargetSite getTargetSite(TargetSiteName name)

Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   TargetSiteName name =
       TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]");
   TargetSite response = siteSearchEngineServiceClient.getTargetSite(name);
 }
 

Parameters:

name - Required. Full resource name of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.

If the caller does not have permission to access the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTargetSite

public final TargetSite getTargetSite(String name)

Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   String name =
       TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
           .toString();
   TargetSite response = siteSearchEngineServiceClient.getTargetSite(name);
 }
 

Parameters:

name - Required. Full resource name of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.

If the caller does not have permission to access the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTargetSite

public final TargetSite getTargetSite(GetTargetSiteRequest request)

Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   GetTargetSiteRequest request =
       GetTargetSiteRequest.newBuilder()
           .setName(
               TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
                   .toString())
           .build();
   TargetSite response = siteSearchEngineServiceClient.getTargetSite(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTargetSiteCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTargetSiteRequest,TargetSite> getTargetSiteCallable()

Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   GetTargetSiteRequest request =
       GetTargetSiteRequest.newBuilder()
           .setName(
               TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
                   .toString())
           .build();
   ApiFuture<TargetSite> future =
       siteSearchEngineServiceClient.getTargetSiteCallable().futureCall(request);
   // Do something.
   TargetSite response = future.get();
 }
 

updateTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<TargetSite,UpdateTargetSiteMetadata> updateTargetSiteAsync(TargetSite targetSite)

Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   TargetSite targetSite = TargetSite.newBuilder().build();
   TargetSite response = siteSearchEngineServiceClient.updateTargetSiteAsync(targetSite).get();
 }
 

Parameters:

targetSite - Required. The target site to update. If the caller does not have permission to update the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] to update does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<TargetSite,UpdateTargetSiteMetadata> updateTargetSiteAsync(UpdateTargetSiteRequest request)

Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   UpdateTargetSiteRequest request =
       UpdateTargetSiteRequest.newBuilder()
           .setTargetSite(TargetSite.newBuilder().build())
           .build();
   TargetSite response = siteSearchEngineServiceClient.updateTargetSiteAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTargetSiteOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateTargetSiteRequest,TargetSite,UpdateTargetSiteMetadata> updateTargetSiteOperationCallable()

Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   UpdateTargetSiteRequest request =
       UpdateTargetSiteRequest.newBuilder()
           .setTargetSite(TargetSite.newBuilder().build())
           .build();
   OperationFuture<TargetSite, UpdateTargetSiteMetadata> future =
       siteSearchEngineServiceClient.updateTargetSiteOperationCallable().futureCall(request);
   // Do something.
   TargetSite response = future.get();
 }
 

updateTargetSiteCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTargetSiteRequest,com.google.longrunning.Operation> updateTargetSiteCallable()

Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   UpdateTargetSiteRequest request =
       UpdateTargetSiteRequest.newBuilder()
           .setTargetSite(TargetSite.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.updateTargetSiteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

deleteTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTargetSiteMetadata> deleteTargetSiteAsync(TargetSiteName name)

Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   TargetSiteName name =
       TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]");
   siteSearchEngineServiceClient.deleteTargetSiteAsync(name).get();
 }
 

Parameters:

name - Required. Full resource name of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.

If the caller does not have permission to access the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTargetSiteMetadata> deleteTargetSiteAsync(String name)

Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   String name =
       TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
           .toString();
   siteSearchEngineServiceClient.deleteTargetSiteAsync(name).get();
 }
 

Parameters:

name - Required. Full resource name of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.

If the caller does not have permission to access the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTargetSiteAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteTargetSiteMetadata> deleteTargetSiteAsync(DeleteTargetSiteRequest request)

Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   DeleteTargetSiteRequest request =
       DeleteTargetSiteRequest.newBuilder()
           .setName(
               TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
                   .toString())
           .build();
   siteSearchEngineServiceClient.deleteTargetSiteAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTargetSiteOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteTargetSiteRequest,com.google.protobuf.Empty,DeleteTargetSiteMetadata> deleteTargetSiteOperationCallable()

Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   DeleteTargetSiteRequest request =
       DeleteTargetSiteRequest.newBuilder()
           .setName(
               TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteTargetSiteMetadata> future =
       siteSearchEngineServiceClient.deleteTargetSiteOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteTargetSiteCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTargetSiteRequest,com.google.longrunning.Operation> deleteTargetSiteCallable()

Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   DeleteTargetSiteRequest request =
       DeleteTargetSiteRequest.newBuilder()
           .setName(
               TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.deleteTargetSiteCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listTargetSites

public final SiteSearchEngineServiceClient.ListTargetSitesPagedResponse listTargetSites(SiteSearchEngineName parent)

Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   SiteSearchEngineName parent =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   for (TargetSite element :
       siteSearchEngineServiceClient.listTargetSites(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

If the caller does not have permission to list [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTargetSites

public final SiteSearchEngineServiceClient.ListTargetSitesPagedResponse listTargetSites(String parent)

Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   String parent =
       SiteSearchEngineName.ofProjectLocationDataStoreName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   for (TargetSite element :
       siteSearchEngineServiceClient.listTargetSites(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

If the caller does not have permission to list [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTargetSites

public final SiteSearchEngineServiceClient.ListTargetSitesPagedResponse listTargetSites(ListTargetSitesRequest request)

Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   ListTargetSitesRequest request =
       ListTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TargetSite element :
       siteSearchEngineServiceClient.listTargetSites(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTargetSitesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTargetSitesRequest,SiteSearchEngineServiceClient.ListTargetSitesPagedResponse> listTargetSitesPagedCallable()

Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   ListTargetSitesRequest request =
       ListTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TargetSite> future =
       siteSearchEngineServiceClient.listTargetSitesPagedCallable().futureCall(request);
   // Do something.
   for (TargetSite element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTargetSitesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTargetSitesRequest,ListTargetSitesResponse> listTargetSitesCallable()

Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   ListTargetSitesRequest request =
       ListTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTargetSitesResponse response =
         siteSearchEngineServiceClient.listTargetSitesCallable().call(request);
     for (TargetSite element : response.getTargetSitesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

enableAdvancedSiteSearchAsync

public final com.google.api.gax.longrunning.OperationFuture<EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata> enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request)

Upgrade from basic site search to advanced site search.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   EnableAdvancedSiteSearchRequest request =
       EnableAdvancedSiteSearchRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   EnableAdvancedSiteSearchResponse response =
       siteSearchEngineServiceClient.enableAdvancedSiteSearchAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

enableAdvancedSiteSearchOperationCallable

public final com.google.api.gax.rpc.OperationCallable<EnableAdvancedSiteSearchRequest,EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata> enableAdvancedSiteSearchOperationCallable()

Upgrade from basic site search to advanced site search.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   EnableAdvancedSiteSearchRequest request =
       EnableAdvancedSiteSearchRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   OperationFuture<EnableAdvancedSiteSearchResponse, EnableAdvancedSiteSearchMetadata> future =
       siteSearchEngineServiceClient
           .enableAdvancedSiteSearchOperationCallable()
           .futureCall(request);
   // Do something.
   EnableAdvancedSiteSearchResponse response = future.get();
 }
 

enableAdvancedSiteSearchCallable

public final com.google.api.gax.rpc.UnaryCallable<EnableAdvancedSiteSearchRequest,com.google.longrunning.Operation> enableAdvancedSiteSearchCallable()

Upgrade from basic site search to advanced site search.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   EnableAdvancedSiteSearchRequest request =
       EnableAdvancedSiteSearchRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.enableAdvancedSiteSearchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

disableAdvancedSiteSearchAsync

public final com.google.api.gax.longrunning.OperationFuture<DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata> disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request)

Downgrade from advanced site search to basic site search.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   DisableAdvancedSiteSearchRequest request =
       DisableAdvancedSiteSearchRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   DisableAdvancedSiteSearchResponse response =
       siteSearchEngineServiceClient.disableAdvancedSiteSearchAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

disableAdvancedSiteSearchOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DisableAdvancedSiteSearchRequest,DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata> disableAdvancedSiteSearchOperationCallable()

Downgrade from advanced site search to basic site search.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   DisableAdvancedSiteSearchRequest request =
       DisableAdvancedSiteSearchRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   OperationFuture<DisableAdvancedSiteSearchResponse, DisableAdvancedSiteSearchMetadata> future =
       siteSearchEngineServiceClient
           .disableAdvancedSiteSearchOperationCallable()
           .futureCall(request);
   // Do something.
   DisableAdvancedSiteSearchResponse response = future.get();
 }
 

disableAdvancedSiteSearchCallable

public final com.google.api.gax.rpc.UnaryCallable<DisableAdvancedSiteSearchRequest,com.google.longrunning.Operation> disableAdvancedSiteSearchCallable()

Downgrade from advanced site search to basic site search.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   DisableAdvancedSiteSearchRequest request =
       DisableAdvancedSiteSearchRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.disableAdvancedSiteSearchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

recrawlUrisAsync

public final com.google.api.gax.longrunning.OperationFuture<RecrawlUrisResponse,RecrawlUrisMetadata> recrawlUrisAsync(RecrawlUrisRequest request)

Request on-demand recrawl for a list of URIs.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   RecrawlUrisRequest request =
       RecrawlUrisRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllUris(new ArrayList<String>())
           .build();
   RecrawlUrisResponse response = siteSearchEngineServiceClient.recrawlUrisAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

recrawlUrisOperationCallable

public final com.google.api.gax.rpc.OperationCallable<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata> recrawlUrisOperationCallable()

Request on-demand recrawl for a list of URIs.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   RecrawlUrisRequest request =
       RecrawlUrisRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllUris(new ArrayList<String>())
           .build();
   OperationFuture<RecrawlUrisResponse, RecrawlUrisMetadata> future =
       siteSearchEngineServiceClient.recrawlUrisOperationCallable().futureCall(request);
   // Do something.
   RecrawlUrisResponse response = future.get();
 }
 

recrawlUrisCallable

public final com.google.api.gax.rpc.UnaryCallable<RecrawlUrisRequest,com.google.longrunning.Operation> recrawlUrisCallable()

Request on-demand recrawl for a list of URIs.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   RecrawlUrisRequest request =
       RecrawlUrisRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllUris(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.recrawlUrisCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

batchVerifyTargetSitesAsync

public final com.google.api.gax.longrunning.OperationFuture<BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata> batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request)

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   BatchVerifyTargetSitesRequest request =
       BatchVerifyTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .build();
   BatchVerifyTargetSitesResponse response =
       siteSearchEngineServiceClient.batchVerifyTargetSitesAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchVerifyTargetSitesOperationCallable

public final com.google.api.gax.rpc.OperationCallable<BatchVerifyTargetSitesRequest,BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata> batchVerifyTargetSitesOperationCallable()

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   BatchVerifyTargetSitesRequest request =
       BatchVerifyTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .build();
   OperationFuture<BatchVerifyTargetSitesResponse, BatchVerifyTargetSitesMetadata> future =
       siteSearchEngineServiceClient
           .batchVerifyTargetSitesOperationCallable()
           .futureCall(request);
   // Do something.
   BatchVerifyTargetSitesResponse response = future.get();
 }
 

batchVerifyTargetSitesCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchVerifyTargetSitesRequest,com.google.longrunning.Operation> batchVerifyTargetSitesCallable()

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   BatchVerifyTargetSitesRequest request =
       BatchVerifyTargetSitesRequest.newBuilder()
           .setParent(
               SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       siteSearchEngineServiceClient.batchVerifyTargetSitesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

fetchDomainVerificationStatus

public final SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse fetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request)

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   FetchDomainVerificationStatusRequest request =
       FetchDomainVerificationStatusRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (TargetSite element :
       siteSearchEngineServiceClient.fetchDomainVerificationStatus(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

fetchDomainVerificationStatusPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<FetchDomainVerificationStatusRequest,SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse> fetchDomainVerificationStatusPagedCallable()

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   FetchDomainVerificationStatusRequest request =
       FetchDomainVerificationStatusRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<TargetSite> future =
       siteSearchEngineServiceClient
           .fetchDomainVerificationStatusPagedCallable()
           .futureCall(request);
   // Do something.
   for (TargetSite element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

fetchDomainVerificationStatusCallable

public final com.google.api.gax.rpc.UnaryCallable<FetchDomainVerificationStatusRequest,FetchDomainVerificationStatusResponse> fetchDomainVerificationStatusCallable()

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
     SiteSearchEngineServiceClient.create()) {
   FetchDomainVerificationStatusRequest request =
       FetchDomainVerificationStatusRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     FetchDomainVerificationStatusResponse response =
         siteSearchEngineServiceClient.fetchDomainVerificationStatusCallable().call(request);
     for (TargetSite element : response.getTargetSitesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException