com.google.cloud.discoveryengine.v1beta.EngineServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-discoveryengine Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.discoveryengine.v1beta;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.discoveryengine.v1beta.stub.EngineServiceStub;
import com.google.cloud.discoveryengine.v1beta.stub.EngineServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for managing [Engine][google.cloud.discoveryengine.v1beta.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:
*
*
{@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);
* }
* }
*
* 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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.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:
*
*
{@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
* EngineServiceSettings engineServiceSettings =
* EngineServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* EngineServiceClient engineServiceClient = EngineServiceClient.create(engineServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* EngineServiceSettings engineServiceSettings =
* EngineServiceSettings.newHttpJsonBuilder().build();
* EngineServiceClient engineServiceClient = EngineServiceClient.create(engineServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class EngineServiceClient implements BackgroundResource {
private final EngineServiceSettings settings;
private final EngineServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of EngineServiceClient with default settings. */
public static final EngineServiceClient create() throws IOException {
return create(EngineServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final EngineServiceClient create(EngineServiceSettings settings)
throws IOException {
return new EngineServiceClient(settings);
}
/**
* Constructs an instance of EngineServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(EngineServiceSettings).
*/
public static final EngineServiceClient create(EngineServiceStub stub) {
return new EngineServiceClient(stub);
}
/**
* 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.
*/
protected EngineServiceClient(EngineServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((EngineServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected EngineServiceClient(EngineServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final EngineServiceSettings getSettings() {
return settings;
}
public EngineServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* CollectionName parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]");
* Engine engine = Engine.newBuilder().build();
* String engineId = "engineId1820490493";
* Engine response = engineServiceClient.createEngineAsync(parent, engine, engineId).get();
* }
* }
*
* @param parent Required. The parent resource name, such as
* `projects/{project}/locations/{location}/collections/{collection}`.
* @param engine Required. The [Engine][google.cloud.discoveryengine.v1beta.Engine] to create.
* @param engineId Required. The ID to use for the
* [Engine][google.cloud.discoveryengine.v1beta.Engine], which will become the final component
* of the [Engine][google.cloud.discoveryengine.v1beta.Engine]'s resource name.
* This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with
* a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createEngineAsync(
CollectionName parent, Engine engine, String engineId) {
CreateEngineRequest request =
CreateEngineRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setEngine(engine)
.setEngineId(engineId)
.build();
return createEngineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* String parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString();
* Engine engine = Engine.newBuilder().build();
* String engineId = "engineId1820490493";
* Engine response = engineServiceClient.createEngineAsync(parent, engine, engineId).get();
* }
* }
*
* @param parent Required. The parent resource name, such as
* `projects/{project}/locations/{location}/collections/{collection}`.
* @param engine Required. The [Engine][google.cloud.discoveryengine.v1beta.Engine] to create.
* @param engineId Required. The ID to use for the
* [Engine][google.cloud.discoveryengine.v1beta.Engine], which will become the final component
* of the [Engine][google.cloud.discoveryengine.v1beta.Engine]'s resource name.
* This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with
* a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createEngineAsync(
String parent, Engine engine, String engineId) {
CreateEngineRequest request =
CreateEngineRequest.newBuilder()
.setParent(parent)
.setEngine(engine)
.setEngineId(engineId)
.build();
return createEngineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* CreateEngineRequest request =
* CreateEngineRequest.newBuilder()
* .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
* .setEngine(Engine.newBuilder().build())
* .setEngineId("engineId1820490493")
* .build();
* Engine response = engineServiceClient.createEngineAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture createEngineAsync(
CreateEngineRequest request) {
return createEngineOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* CreateEngineRequest request =
* CreateEngineRequest.newBuilder()
* .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
* .setEngine(Engine.newBuilder().build())
* .setEngineId("engineId1820490493")
* .build();
* OperationFuture future =
* engineServiceClient.createEngineOperationCallable().futureCall(request);
* // Do something.
* Engine response = future.get();
* }
* }
*/
public final OperationCallable
createEngineOperationCallable() {
return stub.createEngineOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* CreateEngineRequest request =
* CreateEngineRequest.newBuilder()
* .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
* .setEngine(Engine.newBuilder().build())
* .setEngineId("engineId1820490493")
* .build();
* ApiFuture future = engineServiceClient.createEngineCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable createEngineCallable() {
return stub.createEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* EngineName name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
* engineServiceClient.deleteEngineAsync(name).get();
* }
* }
*
* @param name Required. Full resource name of
* [Engine][google.cloud.discoveryengine.v1beta.Engine], such as
* `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
* If the caller does not have permission to delete the
* [Engine][google.cloud.discoveryengine.v1beta.Engine], regardless of whether or not it
* exists, a PERMISSION_DENIED error is returned.
*
If the [Engine][google.cloud.discoveryengine.v1beta.Engine] to delete does not exist, a
* NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteEngineAsync(EngineName name) {
DeleteEngineRequest request =
DeleteEngineRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteEngineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* String name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString();
* engineServiceClient.deleteEngineAsync(name).get();
* }
* }
*
* @param name Required. Full resource name of
* [Engine][google.cloud.discoveryengine.v1beta.Engine], such as
* `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
* If the caller does not have permission to delete the
* [Engine][google.cloud.discoveryengine.v1beta.Engine], regardless of whether or not it
* exists, a PERMISSION_DENIED error is returned.
*
If the [Engine][google.cloud.discoveryengine.v1beta.Engine] to delete does not exist, a
* NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteEngineAsync(String name) {
DeleteEngineRequest request = DeleteEngineRequest.newBuilder().setName(name).build();
return deleteEngineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* DeleteEngineRequest request =
* DeleteEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* engineServiceClient.deleteEngineAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture deleteEngineAsync(
DeleteEngineRequest request) {
return deleteEngineOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* DeleteEngineRequest request =
* DeleteEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* OperationFuture future =
* engineServiceClient.deleteEngineOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable
deleteEngineOperationCallable() {
return stub.deleteEngineOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* DeleteEngineRequest request =
* DeleteEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* ApiFuture future = engineServiceClient.deleteEngineCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteEngineCallable() {
return stub.deleteEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an [Engine][google.cloud.discoveryengine.v1beta.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()) {
* Engine engine = Engine.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Engine response = engineServiceClient.updateEngine(engine, updateMask);
* }
* }
*
* @param engine Required. The [Engine][google.cloud.discoveryengine.v1beta.Engine] to update.
* If the caller does not have permission to update the
* [Engine][google.cloud.discoveryengine.v1beta.Engine], regardless of whether or not it
* exists, a PERMISSION_DENIED error is returned.
*
If the [Engine][google.cloud.discoveryengine.v1beta.Engine] to update does not exist, a
* NOT_FOUND error is returned.
* @param updateMask Indicates which fields in the provided
* [Engine][google.cloud.discoveryengine.v1beta.Engine] to update.
*
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine updateEngine(Engine engine, FieldMask updateMask) {
UpdateEngineRequest request =
UpdateEngineRequest.newBuilder().setEngine(engine).setUpdateMask(updateMask).build();
return updateEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an [Engine][google.cloud.discoveryengine.v1beta.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();
* Engine response = engineServiceClient.updateEngine(request);
* }
* }
*
* @param 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
*/
public final Engine updateEngine(UpdateEngineRequest request) {
return updateEngineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates an [Engine][google.cloud.discoveryengine.v1beta.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.
* Engine response = future.get();
* }
* }
*/
public final UnaryCallable updateEngineCallable() {
return stub.updateEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* EngineName name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
* Engine response = engineServiceClient.getEngine(name);
* }
* }
*
* @param name Required. Full resource name of
* [Engine][google.cloud.discoveryengine.v1beta.Engine], such as
* `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine getEngine(EngineName name) {
GetEngineRequest request =
GetEngineRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* String name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString();
* Engine response = engineServiceClient.getEngine(name);
* }
* }
*
* @param name Required. Full resource name of
* [Engine][google.cloud.discoveryengine.v1beta.Engine], such as
* `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine getEngine(String name) {
GetEngineRequest request = GetEngineRequest.newBuilder().setName(name).build();
return getEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* GetEngineRequest request =
* GetEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* Engine response = engineServiceClient.getEngine(request);
* }
* }
*
* @param 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
*/
public final Engine getEngine(GetEngineRequest request) {
return getEngineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [Engine][google.cloud.discoveryengine.v1beta.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()) {
* GetEngineRequest request =
* GetEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* ApiFuture future = engineServiceClient.getEngineCallable().futureCall(request);
* // Do something.
* Engine response = future.get();
* }
* }
*/
public final UnaryCallable getEngineCallable() {
return stub.getEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the
* project.
*
* 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()) {
* CollectionName parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]");
* for (Engine element : engineServiceClient.listEngines(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent resource name, such as
* `projects/{project}/locations/{location}/collections/{collection_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEnginesPagedResponse listEngines(CollectionName parent) {
ListEnginesRequest request =
ListEnginesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listEngines(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the
* project.
*
* 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()) {
* String parent = CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString();
* for (Engine element : engineServiceClient.listEngines(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent resource name, such as
* `projects/{project}/locations/{location}/collections/{collection_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListEnginesPagedResponse listEngines(String parent) {
ListEnginesRequest request = ListEnginesRequest.newBuilder().setParent(parent).build();
return listEngines(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the
* project.
*
* 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()) {
* ListEnginesRequest request =
* ListEnginesRequest.newBuilder()
* .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .build();
* for (Engine element : engineServiceClient.listEngines(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListEnginesPagedResponse listEngines(ListEnginesRequest request) {
return listEnginesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the
* project.
*
* 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()) {
* ListEnginesRequest request =
* ListEnginesRequest.newBuilder()
* .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .build();
* ApiFuture future = engineServiceClient.listEnginesPagedCallable().futureCall(request);
* // Do something.
* for (Engine element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listEnginesPagedCallable() {
return stub.listEnginesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the
* project.
*
* 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()) {
* ListEnginesRequest request =
* ListEnginesRequest.newBuilder()
* .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setFilter("filter-1274492040")
* .build();
* while (true) {
* ListEnginesResponse response = engineServiceClient.listEnginesCallable().call(request);
* for (Engine element : response.getEnginesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable listEnginesCallable() {
return stub.listEnginesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Pauses the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* EngineName name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
* Engine response = engineServiceClient.pauseEngine(name);
* }
* }
*
* @param name Required. The name of the engine to pause. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine pauseEngine(EngineName name) {
PauseEngineRequest request =
PauseEngineRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return pauseEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Pauses the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* String name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString();
* Engine response = engineServiceClient.pauseEngine(name);
* }
* }
*
* @param name Required. The name of the engine to pause. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine pauseEngine(String name) {
PauseEngineRequest request = PauseEngineRequest.newBuilder().setName(name).build();
return pauseEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Pauses the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* PauseEngineRequest request =
* PauseEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* Engine response = engineServiceClient.pauseEngine(request);
* }
* }
*
* @param 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
*/
public final Engine pauseEngine(PauseEngineRequest request) {
return pauseEngineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Pauses the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* PauseEngineRequest request =
* PauseEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* ApiFuture future = engineServiceClient.pauseEngineCallable().futureCall(request);
* // Do something.
* Engine response = future.get();
* }
* }
*/
public final UnaryCallable pauseEngineCallable() {
return stub.pauseEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resumes the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* EngineName name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
* Engine response = engineServiceClient.resumeEngine(name);
* }
* }
*
* @param name Required. The name of the engine to resume. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine resumeEngine(EngineName name) {
ResumeEngineRequest request =
ResumeEngineRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return resumeEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resumes the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* String name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString();
* Engine response = engineServiceClient.resumeEngine(name);
* }
* }
*
* @param name Required. The name of the engine to resume. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Engine resumeEngine(String name) {
ResumeEngineRequest request = ResumeEngineRequest.newBuilder().setName(name).build();
return resumeEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resumes the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* ResumeEngineRequest request =
* ResumeEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* Engine response = engineServiceClient.resumeEngine(request);
* }
* }
*
* @param 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
*/
public final Engine resumeEngine(ResumeEngineRequest request) {
return resumeEngineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Resumes the training of an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* ResumeEngineRequest request =
* ResumeEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* ApiFuture future = engineServiceClient.resumeEngineCallable().futureCall(request);
* // Do something.
* Engine response = future.get();
* }
* }
*/
public final UnaryCallable resumeEngineCallable() {
return stub.resumeEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Tunes an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* EngineName name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]");
* TuneEngineResponse response = engineServiceClient.tuneEngineAsync(name).get();
* }
* }
*
* @param name Required. The resource name of the engine to tune. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture tuneEngineAsync(
EngineName name) {
TuneEngineRequest request =
TuneEngineRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return tuneEngineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Tunes an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* String name = EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString();
* TuneEngineResponse response = engineServiceClient.tuneEngineAsync(name).get();
* }
* }
*
* @param name Required. The resource name of the engine to tune. Format:
* `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture tuneEngineAsync(
String name) {
TuneEngineRequest request = TuneEngineRequest.newBuilder().setName(name).build();
return tuneEngineAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Tunes an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* TuneEngineRequest request =
* TuneEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* TuneEngineResponse response = engineServiceClient.tuneEngineAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture tuneEngineAsync(
TuneEngineRequest request) {
return tuneEngineOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Tunes an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* TuneEngineRequest request =
* TuneEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* OperationFuture future =
* engineServiceClient.tuneEngineOperationCallable().futureCall(request);
* // Do something.
* TuneEngineResponse response = future.get();
* }
* }
*/
public final OperationCallable
tuneEngineOperationCallable() {
return stub.tuneEngineOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Tunes an existing engine. Only applicable if
* [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is
* [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
*
* 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()) {
* TuneEngineRequest request =
* TuneEngineRequest.newBuilder()
* .setName(
* EngineName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]").toString())
* .build();
* ApiFuture future = engineServiceClient.tuneEngineCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable tuneEngineCallable() {
return stub.tuneEngineCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListEnginesPagedResponse
extends AbstractPagedListResponse<
ListEnginesRequest,
ListEnginesResponse,
Engine,
ListEnginesPage,
ListEnginesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListEnginesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage, input -> new ListEnginesPagedResponse(input), MoreExecutors.directExecutor());
}
private ListEnginesPagedResponse(ListEnginesPage page) {
super(page, ListEnginesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListEnginesPage
extends AbstractPage {
private ListEnginesPage(
PageContext context,
ListEnginesResponse response) {
super(context, response);
}
private static ListEnginesPage createEmptyPage() {
return new ListEnginesPage(null, null);
}
@Override
protected ListEnginesPage createPage(
PageContext context,
ListEnginesResponse response) {
return new ListEnginesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListEnginesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListEnginesRequest,
ListEnginesResponse,
Engine,
ListEnginesPage,
ListEnginesFixedSizeCollection> {
private ListEnginesFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListEnginesFixedSizeCollection createEmptyCollection() {
return new ListEnginesFixedSizeCollection(null, 0);
}
@Override
protected ListEnginesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListEnginesFixedSizeCollection(pages, collectionSize);
}
}
}