com.google.cloud.discoveryengine.v1

Class ServingConfigServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1.ServingConfigServiceClient

All Implemented Interfaces:

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

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

Service Description: Service for operations related to [ServingConfig][google.cloud.discoveryengine.v1.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()

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServingConfigServiceClient(ServingConfigServiceSettings settings) Constructs an instance of ServingConfigServiceClient, using the given settings.
protected	ServingConfigServiceClient(ServingConfigServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ServingConfigServiceClient	create() Constructs an instance of ServingConfigServiceClient with default settings.
static ServingConfigServiceClient	create(ServingConfigServiceSettings settings) Constructs an instance of ServingConfigServiceClient, using the given settings.
static ServingConfigServiceClient	create(ServingConfigServiceStub stub) Constructs an instance of ServingConfigServiceClient, using the given stub for making calls.
ServingConfigServiceSettings	getSettings()
ServingConfigServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
ServingConfig	updateServingConfig(ServingConfig servingConfig, com.google.protobuf.FieldMask updateMask) Updates a ServingConfig.
ServingConfig	updateServingConfig(UpdateServingConfigRequest request) Updates a ServingConfig.
com.google.api.gax.rpc.UnaryCallable<UpdateServingConfigRequest,ServingConfig>	updateServingConfigCallable() Updates a ServingConfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServingConfigServiceClient

protected ServingConfigServiceClient(ServingConfigServiceSettings settings)
                              throws IOException

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.

Throws:

IOException

ServingConfigServiceClient

protected ServingConfigServiceClient(ServingConfigServiceStub stub)

Method Detail

create

public static final ServingConfigServiceClient create()
                                               throws IOException

Constructs an instance of ServingConfigServiceClient with default settings.

Throws:

IOException

create

public static final ServingConfigServiceClient create(ServingConfigServiceSettings settings)
                                               throws IOException

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.

Throws:

IOException

create

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

getSettings

public final ServingConfigServiceSettings getSettings()

getStub

public ServingConfigServiceStub getStub()

updateServingConfig

public final ServingConfig updateServingConfig(ServingConfig servingConfig,
                                               com.google.protobuf.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:

servingConfig - Required. The ServingConfig to update.

updateMask - Indicates which fields in the provided [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to update. The following are NOT supported:

• [ServingConfig.name][google.cloud.discoveryengine.v1.ServingConfig.name]

If not set, all supported fields are updated.

Throws:

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

updateServingConfig

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);
 }
 

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

updateServingConfigCallable

public final com.google.api.gax.rpc.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();
 }
 

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