@BetaApi @Generated(value="by gapic-generator-java") public class ServingConfigServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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 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.
| Modifier and Type | Class and Description |
|---|---|
static class |
ServingConfigServiceClient.ListServingConfigsFixedSizeCollection |
static class |
ServingConfigServiceClient.ListServingConfigsPage |
static class |
ServingConfigServiceClient.ListServingConfigsPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
ServingConfigServiceClient(ServingConfigServiceSettings settings)
Constructs an instance of ServingConfigServiceClient, using the given settings.
|
protected |
ServingConfigServiceClient(ServingConfigServiceStub stub) |
protected ServingConfigServiceClient(ServingConfigServiceSettings settings) throws IOException
IOExceptionprotected ServingConfigServiceClient(ServingConfigServiceStub stub)
public static final ServingConfigServiceClient create() throws IOException
IOExceptionpublic static final ServingConfigServiceClient create(ServingConfigServiceSettings settings) throws IOException
IOExceptionpublic static final ServingConfigServiceClient create(ServingConfigServiceStub stub)
public final ServingConfigServiceSettings getSettings()
public ServingConfigServiceStub getStub()
public final ServingConfig updateServingConfig(ServingConfig servingConfig, com.google.protobuf.FieldMask updateMask)
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);
}
servingConfig - Required. The ServingConfig to update.updateMask - Indicates which fields in the provided
[ServingConfig][google.cloud.discoveryengine.v1alpha.ServingConfig] to update. The
following are NOT supported:
If not set, all supported fields are updated.
com.google.api.gax.rpc.ApiException - if the remote call failspublic final ServingConfig updateServingConfig(UpdateServingConfigRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<UpdateServingConfigRequest,ServingConfig> updateServingConfigCallable()
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();
}
public final ServingConfig getServingConfig(ServingConfigName name)
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);
}
name - Required. The resource name of the ServingConfig to get. Format:
`projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ServingConfig getServingConfig(String name)
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);
}
name - Required. The resource name of the ServingConfig to get. Format:
`projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ServingConfig getServingConfig(GetServingConfigRequest request)
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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetServingConfigRequest,ServingConfig> getServingConfigCallable()
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();
}
public final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(DataStoreName parent)
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);
}
}
parent - Required. Full resource name of the parent resource. Format:
`projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(EngineName parent)
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);
}
}
parent - Required. Full resource name of the parent resource. Format:
`projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(String parent)
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);
}
}
parent - Required. Full resource name of the parent resource. Format:
`projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`com.google.api.gax.rpc.ApiException - if the remote call failspublic final ServingConfigServiceClient.ListServingConfigsPagedResponse listServingConfigs(ListServingConfigsRequest request)
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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListServingConfigsRequest,ServingConfigServiceClient.ListServingConfigsPagedResponse> listServingConfigsPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListServingConfigsRequest,ListServingConfigsResponse> listServingConfigsCallable()
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;
}
}
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2025 Google LLC. All rights reserved.