EngineServiceClient (Google Discovery Engine API 0.52.0 API)

java.lang.Object
- com.google.cloud.discoveryengine.v1alpha.EngineServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: Service for managing [Engine][google.cloud.discoveryengine.v1alpha.Engine] configuration.

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 (EngineServiceClient engineServiceClient = EngineServiceClient.create()) {
   Engine engine = Engine.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Engine response = engineServiceClient.updateEngine(engine, updateMask);
 }

Note: close() needs to be called on the EngineServiceClient 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
CreateEngine	Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createEngineAsync(CreateEngineRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createEngineAsync(CollectionName parent, Engine engine, String engineId) createEngineAsync(String parent, Engine engine, String engineId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createEngineOperationCallable() createEngineCallable()
DeleteEngine	Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteEngineAsync(DeleteEngineRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteEngineAsync(EngineName name) deleteEngineAsync(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. deleteEngineOperationCallable() deleteEngineCallable()
UpdateEngine	Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine]	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateEngine(UpdateEngineRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateEngine(Engine engine, 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. updateEngineCallable()
GetEngine	Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEngine(GetEngineRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEngine(EngineName name) getEngine(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. getEngineCallable()
ListEngines	Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s associated with the project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEngines(ListEnginesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEngines(CollectionName parent) listEngines(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. listEnginesPagedCallable() listEnginesCallable()
PauseEngine	Pauses the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].	Request object method variants only take one parameter, a request object, which must be constructed before the call. pauseEngine(PauseEngineRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. pauseEngine(EngineName name) pauseEngine(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. pauseEngineCallable()
ResumeEngine	Resumes the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].	Request object method variants only take one parameter, a request object, which must be constructed before the call. resumeEngine(ResumeEngineRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. resumeEngine(EngineName name) resumeEngine(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. resumeEngineCallable()
TuneEngine	Tunes an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1alpha.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].	Request object method variants only take one parameter, a request object, which must be constructed before the call. tuneEngineAsync(TuneEngineRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. tuneEngineAsync(EngineName name) tuneEngineAsync(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. tuneEngineOperationCallable() tuneEngineCallable()

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 EngineServiceSettings 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
 EngineServiceSettings engineServiceSettings =
     EngineServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EngineServiceClient engineServiceClient = EngineServiceClient.create(engineServiceSettings);

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
 EngineServiceSettings engineServiceSettings =
     EngineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EngineServiceClient engineServiceClient = EngineServiceClient.create(engineServiceSettings);

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
 EngineServiceSettings engineServiceSettings =
     EngineServiceSettings.newHttpJsonBuilder().build();
 EngineServiceClient engineServiceClient = EngineServiceClient.create(engineServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EngineServiceClient.ListEnginesFixedSizeCollection`
`static class`	`EngineServiceClient.ListEnginesPage`
`static class`	`EngineServiceClient.ListEnginesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`EngineServiceClient(EngineServiceSettings settings)` Constructs an instance of EngineServiceClient, using the given settings.
`protected`	`EngineServiceClient(EngineServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static EngineServiceClient`	`create()` Constructs an instance of EngineServiceClient with default settings.
`static EngineServiceClient`	`create(EngineServiceSettings settings)` Constructs an instance of EngineServiceClient, using the given settings.
`static EngineServiceClient`	`create(EngineServiceStub stub)` Constructs an instance of EngineServiceClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Engine,CreateEngineMetadata>`	`createEngineAsync(CollectionName parent, Engine engine, String engineId)` Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.longrunning.OperationFuture<Engine,CreateEngineMetadata>`	`createEngineAsync(CreateEngineRequest request)` Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.longrunning.OperationFuture<Engine,CreateEngineMetadata>`	`createEngineAsync(String parent, Engine engine, String engineId)` Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.rpc.UnaryCallable<CreateEngineRequest,com.google.longrunning.Operation>`	`createEngineCallable()` Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.rpc.OperationCallable<CreateEngineRequest,Engine,CreateEngineMetadata>`	`createEngineOperationCallable()` Creates a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteEngineMetadata>`	`deleteEngineAsync(DeleteEngineRequest request)` Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteEngineMetadata>`	`deleteEngineAsync(EngineName name)` Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteEngineMetadata>`	`deleteEngineAsync(String name)` Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.rpc.UnaryCallable<DeleteEngineRequest,com.google.longrunning.Operation>`	`deleteEngineCallable()` Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.rpc.OperationCallable<DeleteEngineRequest,com.google.protobuf.Empty,DeleteEngineMetadata>`	`deleteEngineOperationCallable()` Deletes a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`Engine`	`getEngine(EngineName name)` Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`Engine`	`getEngine(GetEngineRequest request)` Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`Engine`	`getEngine(String name)` Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.rpc.UnaryCallable<GetEngineRequest,Engine>`	`getEngineCallable()` Gets a [Engine][google.cloud.discoveryengine.v1alpha.Engine].
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`EngineServiceSettings`	`getSettings()`
`EngineServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`EngineServiceClient.ListEnginesPagedResponse`	`listEngines(CollectionName parent)` Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s associated with the project.
`EngineServiceClient.ListEnginesPagedResponse`	`listEngines(ListEnginesRequest request)` Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s associated with the project.
`EngineServiceClient.ListEnginesPagedResponse`	`listEngines(String parent)` Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s associated with the project.
`com.google.api.gax.rpc.UnaryCallable<ListEnginesRequest,ListEnginesResponse>`	`listEnginesCallable()` Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s associated with the project.
`com.google.api.gax.rpc.UnaryCallable<ListEnginesRequest,EngineServiceClient.ListEnginesPagedResponse>`	`listEnginesPagedCallable()` Lists all the [Engine][google.cloud.discoveryengine.v1alpha.Engine]s associated with the project.
`Engine`	`pauseEngine(EngineName name)` Pauses the training of an existing engine.
`Engine`	`pauseEngine(PauseEngineRequest request)` Pauses the training of an existing engine.
`Engine`	`pauseEngine(String name)` Pauses the training of an existing engine.
`com.google.api.gax.rpc.UnaryCallable<PauseEngineRequest,Engine>`	`pauseEngineCallable()` Pauses the training of an existing engine.
`Engine`	`resumeEngine(EngineName name)` Resumes the training of an existing engine.
`Engine`	`resumeEngine(ResumeEngineRequest request)` Resumes the training of an existing engine.
`Engine`	`resumeEngine(String name)` Resumes the training of an existing engine.
`com.google.api.gax.rpc.UnaryCallable<ResumeEngineRequest,Engine>`	`resumeEngineCallable()` Resumes the training of an existing engine.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.api.gax.longrunning.OperationFuture<TuneEngineResponse,TuneEngineMetadata>`	`tuneEngineAsync(EngineName name)` Tunes an existing engine.
`com.google.api.gax.longrunning.OperationFuture<TuneEngineResponse,TuneEngineMetadata>`	`tuneEngineAsync(String name)` Tunes an existing engine.
`com.google.api.gax.longrunning.OperationFuture<TuneEngineResponse,TuneEngineMetadata>`	`tuneEngineAsync(TuneEngineRequest request)` Tunes an existing engine.
`com.google.api.gax.rpc.UnaryCallable<TuneEngineRequest,com.google.longrunning.Operation>`	`tuneEngineCallable()` Tunes an existing engine.
`com.google.api.gax.rpc.OperationCallable<TuneEngineRequest,TuneEngineResponse,TuneEngineMetadata>`	`tuneEngineOperationCallable()` Tunes an existing engine.
`Engine`	`updateEngine(Engine engine, com.google.protobuf.FieldMask updateMask)` Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] 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 (EngineServiceClient engineServiceClient = EngineServiceClient.create()) { Engine engine = Engine.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Engine response = engineServiceClient.updateEngine(engine, updateMask); }
`Engine`	`updateEngine(UpdateEngineRequest request)` Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] 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 (EngineServiceClient engineServiceClient = EngineServiceClient.create()) { UpdateEngineRequest request = UpdateEngineRequest.newBuilder() .setEngine(Engine.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Engine response = engineServiceClient.updateEngine(request); }
`com.google.api.gax.rpc.UnaryCallable<UpdateEngineRequest,Engine>`	`updateEngineCallable()` Updates an [Engine][google.cloud.discoveryengine.v1alpha.Engine] Sample code: {@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 (EngineServiceClient engineServiceClient = EngineServiceClient.create()) { UpdateEngineRequest request = UpdateEngineRequest.newBuilder() .setEngine(Engine.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture future = engineServiceClient.updateEngineCallable().futureCall(request); // Do something.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EngineServiceClient
```
protected EngineServiceClient(EngineServiceSettings settings)
                       throws IOException
```
  Constructs an instance of EngineServiceClient, 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
- EngineServiceClient
```
protected EngineServiceClient(EngineServiceStub stub)
```

Method Detail

create

public static final EngineServiceClient create()
                                        throws IOException

Constructs an instance of EngineServiceClient with default settings.

Throws:: IOException

create
```
public static final EngineServiceClient create(EngineServiceSettings settings)
                                        throws IOException
```
Constructs an instance of EngineServiceClient, 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 EngineServiceClient create(EngineServiceStub stub)
```
Constructs an instance of EngineServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(EngineServiceSettings).

getSettings

public final EngineServiceSettings getSettings()

getStub
```
public EngineServiceStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.