Class ServingConfigServiceClient (0.51.0)

Version latest

• 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 operations related to ServingConfig.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   ServingConfig servingConfig = ServingConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ServingConfig response =
       servingConfigServiceClient.updateServingConfig(servingConfig, updateMask);
 }
 

Note: close() needs to be called on the ServingConfigServiceClient 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
UpdateServingConfig	Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateServingConfig(UpdateServingConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateServingConfig(ServingConfig servingConfig, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateServingConfigCallable()
GetServingConfig	Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getServingConfig(GetServingConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getServingConfig(ServingConfigName name) getServingConfig(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. getServingConfigCallable()
ListServingConfigs	Lists all ServingConfigs linked to this dataStore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listServingConfigs(ListServingConfigsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listServingConfigs(DataStoreName parent) listServingConfigs(EngineName parent) listServingConfigs(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. listServingConfigsPagedCallable() listServingConfigsCallable()

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 ServingConfigServiceSettings 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
 ServingConfigServiceSettings servingConfigServiceSettings =
     ServingConfigServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create(servingConfigServiceSettings);
 

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
 ServingConfigServiceSettings servingConfigServiceSettings =
     ServingConfigServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create(servingConfigServiceSettings);
 

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
 ServingConfigServiceSettings servingConfigServiceSettings =
     ServingConfigServiceSettings.newHttpJsonBuilder().build();
 ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create(servingConfigServiceSettings);
 

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

Inheritance

java.lang.Object > ServingConfigServiceClient

Static Methods

create()

public static final ServingConfigServiceClient create()

Constructs an instance of ServingConfigServiceClient with default settings.

Returns
Type	Description
ServingConfigServiceClient

Exceptions
Type	Description
IOException

create(ServingConfigServiceSettings settings)

public static final ServingConfigServiceClient create(ServingConfigServiceSettings settings)

Constructs an instance of ServingConfigServiceClient, 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	ServingConfigServiceSettings

Returns
Type	Description
ServingConfigServiceClient

Exceptions
Type	Description
IOException

create(ServingConfigServiceStub stub)

public static final ServingConfigServiceClient create(ServingConfigServiceStub stub)

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

Parameter
Name	Description
stub	ServingConfigServiceStub

Returns
Type	Description
ServingConfigServiceClient

Constructors

ServingConfigServiceClient(ServingConfigServiceSettings settings)

protected ServingConfigServiceClient(ServingConfigServiceSettings settings)

Constructs an instance of ServingConfigServiceClient, 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	ServingConfigServiceSettings

ServingConfigServiceClient(ServingConfigServiceStub stub)

protected ServingConfigServiceClient(ServingConfigServiceStub stub)

Parameter
Name	Description
stub	ServingConfigServiceStub

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

getServingConfig(GetServingConfigRequest request)

public final ServingConfig getServingConfig(GetServingConfigRequest request)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   GetServingConfigRequest request =
       GetServingConfigRequest.newBuilder()
           .setName(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .build();
   ServingConfig response = servingConfigServiceClient.getServingConfig(request);
 }
 

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

Returns
Type	Description
ServingConfig

getServingConfig(ServingConfigName name)

public final ServingConfig getServingConfig(ServingConfigName name)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   ServingConfigName name =
       ServingConfigName.ofProjectLocationDataStoreServingConfigName(
           "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]");
   ServingConfig response = servingConfigServiceClient.getServingConfig(name);
 }
 

Parameter
Name	Description
name	ServingConfigName Required. The resource name of the ServingConfig to get. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

Returns
Type	Description
ServingConfig

getServingConfig(String name)

public final ServingConfig getServingConfig(String name)

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   String name =
       ServingConfigName.ofProjectLocationDataStoreServingConfigName(
               "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
           .toString();
   ServingConfig response = servingConfigServiceClient.getServingConfig(name);
 }
 

Parameter
Name	Description
name	String Required. The resource name of the ServingConfig to get. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

Returns
Type	Description
ServingConfig

getServingConfigCallable()

public final UnaryCallable<GetServingConfigRequest,ServingConfig> getServingConfigCallable()

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   GetServingConfigRequest request =
       GetServingConfigRequest.newBuilder()
           .setName(
               ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                   .toString())
           .build();
   ApiFuture<ServingConfig> future =
       servingConfigServiceClient.getServingConfigCallable().futureCall(request);
   // Do something.
   ServingConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetServingConfigRequest,ServingConfig>

getSettings()

public final ServingConfigServiceSettings getSettings()

Returns
Type	Description
ServingConfigServiceSettings

getStub()

public ServingConfigServiceStub getStub()

Returns
Type	Description
ServingConfigServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listServingConfigs(DataStoreName parent)

public final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(DataStoreName parent)

Lists all ServingConfigs linked to this dataStore.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   DataStoreName parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
   for (ServingConfig element :
       servingConfigServiceClient.listServingConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	DataStoreName Required. Full resource name of the parent resource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type	Description
ServingConfigServiceClient.ListServingConfigsPagedResponse

listServingConfigs(EngineName parent)

public final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(EngineName parent)

Lists all ServingConfigs linked to this dataStore.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   EngineName parent = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
   for (ServingConfig element :
       servingConfigServiceClient.listServingConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	EngineName Required. Full resource name of the parent resource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type	Description
ServingConfigServiceClient.ListServingConfigsPagedResponse

listServingConfigs(ListServingConfigsRequest request)

public final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(ListServingConfigsRequest request)

Lists all ServingConfigs linked to this dataStore.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   ListServingConfigsRequest request =
       ListServingConfigsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ServingConfig element :
       servingConfigServiceClient.listServingConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
ServingConfigServiceClient.ListServingConfigsPagedResponse

listServingConfigs(String parent)

public final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(String parent)

Lists all ServingConfigs linked to this dataStore.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   String parent =
       DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]")
           .toString();
   for (ServingConfig element :
       servingConfigServiceClient.listServingConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. Full resource name of the parent resource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns
Type	Description
ServingConfigServiceClient.ListServingConfigsPagedResponse

listServingConfigsCallable()

public final UnaryCallable<ListServingConfigsRequest,ListServingConfigsResponse> listServingConfigsCallable()

Lists all ServingConfigs linked to this dataStore.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   ListServingConfigsRequest request =
       ListServingConfigsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListServingConfigsResponse response =
         servingConfigServiceClient.listServingConfigsCallable().call(request);
     for (ServingConfig element : response.getServingConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListServingConfigsRequest,ListServingConfigsResponse>

listServingConfigsPagedCallable()

public final UnaryCallable<ListServingConfigsRequest,ServingConfigServiceClient.ListServingConfigsPagedResponse> listServingConfigsPagedCallable()

Lists all ServingConfigs linked to this dataStore.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   ListServingConfigsRequest request =
       ListServingConfigsRequest.newBuilder()
           .setParent(
               DataStoreName.ofProjectLocationDataStoreName(
                       "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ServingConfig> future =
       servingConfigServiceClient.listServingConfigsPagedCallable().futureCall(request);
   // Do something.
   for (ServingConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListServingConfigsRequest,ListServingConfigsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateServingConfig(ServingConfig servingConfig, FieldMask updateMask)

public final ServingConfig updateServingConfig(ServingConfig servingConfig, FieldMask updateMask)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   ServingConfig servingConfig = ServingConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ServingConfig response =
       servingConfigServiceClient.updateServingConfig(servingConfig, updateMask);
 }
 

Parameters
Name	Description
servingConfig	ServingConfig Required. The ServingConfig to update.
updateMask	FieldMask Indicates which fields in the provided ServingConfig to update. The following are NOT supported: ServingConfig.name If not set, all supported fields are updated.

Returns
Type	Description
ServingConfig

updateServingConfig(UpdateServingConfigRequest request)

public final ServingConfig updateServingConfig(UpdateServingConfigRequest request)

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   UpdateServingConfigRequest request =
       UpdateServingConfigRequest.newBuilder()
           .setServingConfig(ServingConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ServingConfig response = servingConfigServiceClient.updateServingConfig(request);
 }
 

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

Returns
Type	Description
ServingConfig

updateServingConfigCallable()

public final UnaryCallable<UpdateServingConfigRequest,ServingConfig> updateServingConfigCallable()

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

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 (ServingConfigServiceClient servingConfigServiceClient =
     ServingConfigServiceClient.create()) {
   UpdateServingConfigRequest request =
       UpdateServingConfigRequest.newBuilder()
           .setServingConfig(ServingConfig.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ServingConfig> future =
       servingConfigServiceClient.updateServingConfigCallable().futureCall(request);
   // Do something.
   ServingConfig response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateServingConfigRequest,ServingConfig>