Class SearchTuningServiceClient (0.43.0)

Version 0.43.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: Service for search tuning.

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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
   ListCustomModelsRequest request =
       ListCustomModelsRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .build();
   ListCustomModelsResponse response = searchTuningServiceClient.listCustomModels(request);
 }
 

Note: close() needs to be called on the SearchTuningServiceClient 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
TrainCustomModel	Trains a custom model.	Request object method variants only take one parameter, a request object, which must be constructed before the call. trainCustomModelAsync(TrainCustomModelRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. trainCustomModelOperationCallable() trainCustomModelCallable()
ListCustomModels	Gets a list of all the custom models.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCustomModels(ListCustomModelsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCustomModelsCallable()

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 SearchTuningServiceSettings 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
 SearchTuningServiceSettings searchTuningServiceSettings =
     SearchTuningServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SearchTuningServiceClient searchTuningServiceClient =
     SearchTuningServiceClient.create(searchTuningServiceSettings);
 

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
 SearchTuningServiceSettings searchTuningServiceSettings =
     SearchTuningServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SearchTuningServiceClient searchTuningServiceClient =
     SearchTuningServiceClient.create(searchTuningServiceSettings);
 

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
 SearchTuningServiceSettings searchTuningServiceSettings =
     SearchTuningServiceSettings.newHttpJsonBuilder().build();
 SearchTuningServiceClient searchTuningServiceClient =
     SearchTuningServiceClient.create(searchTuningServiceSettings);
 

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

Inheritance

java.lang.Object > SearchTuningServiceClient

Static Methods

create()

public static final SearchTuningServiceClient create()

Constructs an instance of SearchTuningServiceClient with default settings.

Returns
Type	Description
SearchTuningServiceClient

Exceptions
Type	Description
IOException

create(SearchTuningServiceSettings settings)

public static final SearchTuningServiceClient create(SearchTuningServiceSettings settings)

Constructs an instance of SearchTuningServiceClient, 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	SearchTuningServiceSettings

Returns
Type	Description
SearchTuningServiceClient

Exceptions
Type	Description
IOException

create(SearchTuningServiceStub stub)

public static final SearchTuningServiceClient create(SearchTuningServiceStub stub)

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

Parameter
Name	Description
stub	SearchTuningServiceStub

Returns
Type	Description
SearchTuningServiceClient

Constructors

SearchTuningServiceClient(SearchTuningServiceSettings settings)

protected SearchTuningServiceClient(SearchTuningServiceSettings settings)

Constructs an instance of SearchTuningServiceClient, 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	SearchTuningServiceSettings

SearchTuningServiceClient(SearchTuningServiceStub stub)

protected SearchTuningServiceClient(SearchTuningServiceStub stub)

Parameter
Name	Description
stub	SearchTuningServiceStub

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

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 SearchTuningServiceSettings getSettings()

Returns
Type	Description
SearchTuningServiceSettings

getStub()

public SearchTuningServiceStub getStub()

Returns
Type	Description
SearchTuningServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listCustomModels(ListCustomModelsRequest request)

public final ListCustomModelsResponse listCustomModels(ListCustomModelsRequest request)

Gets a list of all the custom models.

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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
   ListCustomModelsRequest request =
       ListCustomModelsRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .build();
   ListCustomModelsResponse response = searchTuningServiceClient.listCustomModels(request);
 }
 

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

Returns
Type	Description
ListCustomModelsResponse

listCustomModelsCallable()

public final UnaryCallable<ListCustomModelsRequest,ListCustomModelsResponse> listCustomModelsCallable()

Gets a list of all the custom models.

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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
   ListCustomModelsRequest request =
       ListCustomModelsRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .build();
   ApiFuture<ListCustomModelsResponse> future =
       searchTuningServiceClient.listCustomModelsCallable().futureCall(request);
   // Do something.
   ListCustomModelsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ListCustomModelsRequest,ListCustomModelsResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

trainCustomModelAsync(TrainCustomModelRequest request)

public final OperationFuture<TrainCustomModelResponse,TrainCustomModelMetadata> trainCustomModelAsync(TrainCustomModelRequest request)

Trains a custom model.

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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
   TrainCustomModelRequest request =
       TrainCustomModelRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .setModelType("modelType-2010627581")
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .setModelId("modelId1226956324")
           .build();
   TrainCustomModelResponse response =
       searchTuningServiceClient.trainCustomModelAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<TrainCustomModelResponse,TrainCustomModelMetadata>

trainCustomModelCallable()

public final UnaryCallable<TrainCustomModelRequest,Operation> trainCustomModelCallable()

Trains a custom model.

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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
   TrainCustomModelRequest request =
       TrainCustomModelRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .setModelType("modelType-2010627581")
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .setModelId("modelId1226956324")
           .build();
   ApiFuture<Operation> future =
       searchTuningServiceClient.trainCustomModelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<TrainCustomModelRequest,Operation>

trainCustomModelOperationCallable()

public final OperationCallable<TrainCustomModelRequest,TrainCustomModelResponse,TrainCustomModelMetadata> trainCustomModelOperationCallable()

Trains a custom model.

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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
   TrainCustomModelRequest request =
       TrainCustomModelRequest.newBuilder()
           .setDataStore(
               DataStoreName.ofProjectLocationCollectionDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
                   .toString())
           .setModelType("modelType-2010627581")
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .setModelId("modelId1226956324")
           .build();
   OperationFuture<TrainCustomModelResponse, TrainCustomModelMetadata> future =
       searchTuningServiceClient.trainCustomModelOperationCallable().futureCall(request);
   // Do something.
   TrainCustomModelResponse response = future.get();
 }
 

Returns
Type	Description
OperationCallable<TrainCustomModelRequest,TrainCustomModelResponse,TrainCustomModelMetadata>