Class SiteSearchEngineServiceClient (0.26.0)

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()) {
   RecrawlUrisRequest request =
       RecrawlUrisRequest.newBuilder()
           .setSiteSearchEngine(
               SiteSearchEngineName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .addAllUris(new ArrayList<String>())
           .build();
   RecrawlUrisResponse response = siteSearchEngineServiceClient.recrawlUrisAsync(request).get();
 }

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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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.

Inheritance

java.lang.Object > SiteSearchEngineServiceClient

Static Methods

create()

public static final SiteSearchEngineServiceClient create()

Constructs an instance of SiteSearchEngineServiceClient with default settings.

Returns
Type	Description
`SiteSearchEngineServiceClient`

Exceptions
Type	Description
`IOException`

create(SiteSearchEngineServiceSettings settings)

public static final SiteSearchEngineServiceClient create(SiteSearchEngineServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`SiteSearchEngineServiceSettings`

Returns
Type	Description
`SiteSearchEngineServiceClient`

Exceptions
Type	Description
`IOException`

create(SiteSearchEngineServiceStub stub)

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).

Parameter
Name	Description
`stub`	`SiteSearchEngineServiceStub`

Returns
Type	Description
`SiteSearchEngineServiceClient`

Constructors

SiteSearchEngineServiceClient(SiteSearchEngineServiceSettings settings)

protected SiteSearchEngineServiceClient(SiteSearchEngineServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`SiteSearchEngineServiceSettings`

SiteSearchEngineServiceClient(SiteSearchEngineServiceStub stub)

protected SiteSearchEngineServiceClient(SiteSearchEngineServiceStub stub)

Parameter
Name	Description
`stub`	`SiteSearchEngineServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type	Description
`OperationsClient`

getSettings()

public final SiteSearchEngineServiceSettings getSettings()

Returns
Type	Description
`SiteSearchEngineServiceSettings`

getStub()

public SiteSearchEngineServiceStub getStub()

Returns
Type	Description
`SiteSearchEngineServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

recrawlUrisAsync(RecrawlUrisRequest request)

public final 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();
 }

Parameter
Name	Description
`request`	`RecrawlUrisRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<RecrawlUrisResponse,RecrawlUrisMetadata>`

recrawlUrisCallable()

public final UnaryCallable<RecrawlUrisRequest,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();
 }

Returns
Type	Description
`UnaryCallable<RecrawlUrisRequest,Operation>`

recrawlUrisOperationCallable()

public final 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();
 }

Returns
Type	Description
`OperationCallable<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()