com.google.cloud.discoveryengine.v1alpha

Class EvaluationServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1alpha.EvaluationServiceClient

All Implemented Interfaces:

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

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

Service Description: Service for managing [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s,

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   EvaluationName name = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]");
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
 

Note: close() needs to be called on the EvaluationServiceClient 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
GetEvaluation	Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEvaluation(GetEvaluationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEvaluation(EvaluationName name) getEvaluation(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. getEvaluationCallable()
ListEvaluations	Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEvaluations(ListEvaluationsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEvaluations(LocationName parent) listEvaluations(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. listEvaluationsPagedCallable() listEvaluationsCallable()
CreateEvaluation	Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]. Upon creation, the evaluation will be automatically triggered and begin execution.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createEvaluationAsync(CreateEvaluationRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createEvaluationAsync(LocationName parent, Evaluation evaluation) createEvaluationAsync(String parent, Evaluation evaluation) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createEvaluationOperationCallable() createEvaluationCallable()
ListEvaluationResults	Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEvaluationResults(ListEvaluationResultsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEvaluationResults(EvaluationName evaluation) listEvaluationResults(String evaluation) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listEvaluationResultsPagedCallable() listEvaluationResultsCallable()

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 EvaluationServiceSettings 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
 EvaluationServiceSettings evaluationServiceSettings =
     EvaluationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EvaluationServiceClient evaluationServiceClient =
     EvaluationServiceClient.create(evaluationServiceSettings);
 

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
 EvaluationServiceSettings evaluationServiceSettings =
     EvaluationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EvaluationServiceClient evaluationServiceClient =
     EvaluationServiceClient.create(evaluationServiceSettings);
 

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
 EvaluationServiceSettings evaluationServiceSettings =
     EvaluationServiceSettings.newHttpJsonBuilder().build();
 EvaluationServiceClient evaluationServiceClient =
     EvaluationServiceClient.create(evaluationServiceSettings);
 

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	EvaluationServiceClient.ListEvaluationResultsFixedSizeCollection
static class	EvaluationServiceClient.ListEvaluationResultsPage
static class	EvaluationServiceClient.ListEvaluationResultsPagedResponse
static class	EvaluationServiceClient.ListEvaluationsFixedSizeCollection
static class	EvaluationServiceClient.ListEvaluationsPage
static class	EvaluationServiceClient.ListEvaluationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EvaluationServiceClient(EvaluationServiceSettings settings) Constructs an instance of EvaluationServiceClient, using the given settings.
protected	EvaluationServiceClient(EvaluationServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static EvaluationServiceClient	create() Constructs an instance of EvaluationServiceClient with default settings.
static EvaluationServiceClient	create(EvaluationServiceSettings settings) Constructs an instance of EvaluationServiceClient, using the given settings.
static EvaluationServiceClient	create(EvaluationServiceStub stub) Constructs an instance of EvaluationServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<Evaluation,CreateEvaluationMetadata>	createEvaluationAsync(CreateEvaluationRequest request) Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.longrunning.OperationFuture<Evaluation,CreateEvaluationMetadata>	createEvaluationAsync(LocationName parent, Evaluation evaluation) Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.longrunning.OperationFuture<Evaluation,CreateEvaluationMetadata>	createEvaluationAsync(String parent, Evaluation evaluation) Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.rpc.UnaryCallable<CreateEvaluationRequest,com.google.longrunning.Operation>	createEvaluationCallable() Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.rpc.OperationCallable<CreateEvaluationRequest,Evaluation,CreateEvaluationMetadata>	createEvaluationOperationCallable() Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
Evaluation	getEvaluation(EvaluationName name) Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
Evaluation	getEvaluation(GetEvaluationRequest request) Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
Evaluation	getEvaluation(String name) Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.rpc.UnaryCallable<GetEvaluationRequest,Evaluation>	getEvaluationCallable() Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
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.
EvaluationServiceSettings	getSettings()
EvaluationServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
EvaluationServiceClient.ListEvaluationResultsPagedResponse	listEvaluationResults(EvaluationName evaluation) Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
EvaluationServiceClient.ListEvaluationResultsPagedResponse	listEvaluationResults(ListEvaluationResultsRequest request) Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
EvaluationServiceClient.ListEvaluationResultsPagedResponse	listEvaluationResults(String evaluation) Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.rpc.UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsResponse>	listEvaluationResultsCallable() Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
com.google.api.gax.rpc.UnaryCallable<ListEvaluationResultsRequest,EvaluationServiceClient.ListEvaluationResultsPagedResponse>	listEvaluationResultsPagedCallable() Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].
EvaluationServiceClient.ListEvaluationsPagedResponse	listEvaluations(ListEvaluationsRequest request) Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
EvaluationServiceClient.ListEvaluationsPagedResponse	listEvaluations(LocationName parent) Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
EvaluationServiceClient.ListEvaluationsPagedResponse	listEvaluations(String parent) Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
com.google.api.gax.rpc.UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse>	listEvaluationsCallable() Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
com.google.api.gax.rpc.UnaryCallable<ListEvaluationsRequest,EvaluationServiceClient.ListEvaluationsPagedResponse>	listEvaluationsPagedCallable() Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

EvaluationServiceClient

protected EvaluationServiceClient(EvaluationServiceSettings settings)
                           throws IOException

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

EvaluationServiceClient

protected EvaluationServiceClient(EvaluationServiceStub stub)

Method Detail

create

public static final EvaluationServiceClient create()
                                            throws IOException

Constructs an instance of EvaluationServiceClient with default settings.

Throws:

IOException

create

public static final EvaluationServiceClient create(EvaluationServiceSettings settings)
                                            throws IOException

Constructs an instance of EvaluationServiceClient, 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 EvaluationServiceClient create(EvaluationServiceStub stub)

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

getSettings

public final EvaluationServiceSettings getSettings()

getStub

public EvaluationServiceStub 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.

getEvaluation

public final Evaluation getEvaluation(EvaluationName name)

Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   EvaluationName name = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]");
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
 

Parameters:

name - Required. Full resource name of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], such as `projects/{project}/locations/{location}/evaluations/{evaluation}`.

If the caller does not have permission to access the [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] does not exist, a NOT_FOUND error is returned.

Throws:

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

getEvaluation

public final Evaluation getEvaluation(String name)

Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String name = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString();
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
 

Parameters:

name - Required. Full resource name of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], such as `projects/{project}/locations/{location}/evaluations/{evaluation}`.

If the caller does not have permission to access the [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] does not exist, a NOT_FOUND error is returned.

Throws:

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

getEvaluation

public final Evaluation getEvaluation(GetEvaluationRequest request)

Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .build();
   Evaluation response = evaluationServiceClient.getEvaluation(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

getEvaluationCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEvaluationRequest,Evaluation> getEvaluationCallable()

Gets a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.getEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 

listEvaluations

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(LocationName parent)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Evaluation element : evaluationServiceClient.listEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent location resource name, such as `projects/{project}/locations/{location}`.

If the caller does not have permission to list [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.

Throws:

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

listEvaluations

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(String parent)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Evaluation element : evaluationServiceClient.listEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The parent location resource name, such as `projects/{project}/locations/{location}`.

If the caller does not have permission to list [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.

Throws:

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

listEvaluations

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(ListEvaluationsRequest request)

Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Evaluation element : evaluationServiceClient.listEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listEvaluationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEvaluationsRequest,EvaluationServiceClient.ListEvaluationsPagedResponse> listEvaluationsPagedCallable()

Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.listEvaluationsPagedCallable().futureCall(request);
   // Do something.
   for (Evaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listEvaluationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse> listEvaluationsCallable()

Gets a list of [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation]s.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEvaluationsResponse response =
         evaluationServiceClient.listEvaluationsCallable().call(request);
     for (Evaluation element : response.getEvaluationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

createEvaluationAsync

public final com.google.api.gax.longrunning.OperationFuture<Evaluation,CreateEvaluationMetadata> createEvaluationAsync(LocationName parent,
                                                                                                                       Evaluation evaluation)

Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

Upon creation, the evaluation will be automatically triggered and begin execution.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Evaluation evaluation = Evaluation.newBuilder().build();
   Evaluation response = evaluationServiceClient.createEvaluationAsync(parent, evaluation).get();
 }
 

Parameters:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}`.

evaluation - Required. The [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] to create.

Throws:

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

createEvaluationAsync

public final com.google.api.gax.longrunning.OperationFuture<Evaluation,CreateEvaluationMetadata> createEvaluationAsync(String parent,
                                                                                                                       Evaluation evaluation)

Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

Upon creation, the evaluation will be automatically triggered and begin execution.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Evaluation evaluation = Evaluation.newBuilder().build();
   Evaluation response = evaluationServiceClient.createEvaluationAsync(parent, evaluation).get();
 }
 

Parameters:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}`.

evaluation - Required. The [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation] to create.

Throws:

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

createEvaluationAsync

public final com.google.api.gax.longrunning.OperationFuture<Evaluation,CreateEvaluationMetadata> createEvaluationAsync(CreateEvaluationRequest request)

Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

Upon creation, the evaluation will be automatically triggered and begin execution.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   Evaluation response = evaluationServiceClient.createEvaluationAsync(request).get();
 }
 

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

createEvaluationOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateEvaluationRequest,Evaluation,CreateEvaluationMetadata> createEvaluationOperationCallable()

Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

Upon creation, the evaluation will be automatically triggered and begin execution.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   OperationFuture<Evaluation, CreateEvaluationMetadata> future =
       evaluationServiceClient.createEvaluationOperationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 

createEvaluationCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEvaluationRequest,com.google.longrunning.Operation> createEvaluationCallable()

Creates a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

Upon creation, the evaluation will be automatically triggered and begin execution.

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       evaluationServiceClient.createEvaluationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

listEvaluationResults

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(EvaluationName evaluation)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   EvaluationName evaluation = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]");
   for (ListEvaluationResultsResponse.EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(evaluation).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

evaluation - Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`.

If the caller does not have permission to list [EvaluationResult][] under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.

Throws:

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

listEvaluationResults

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(String evaluation)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String evaluation = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString();
   for (ListEvaluationResultsResponse.EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(evaluation).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

evaluation - Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`.

If the caller does not have permission to list [EvaluationResult][] under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.

Throws:

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

listEvaluationResults

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(ListEvaluationResultsRequest request)

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationResultsRequest request =
       ListEvaluationResultsRequest.newBuilder()
           .setEvaluation(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ListEvaluationResultsResponse.EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listEvaluationResultsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEvaluationResultsRequest,EvaluationServiceClient.ListEvaluationResultsPagedResponse> listEvaluationResultsPagedCallable()

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationResultsRequest request =
       ListEvaluationResultsRequest.newBuilder()
           .setEvaluation(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ListEvaluationResultsResponse.EvaluationResult> future =
       evaluationServiceClient.listEvaluationResultsPagedCallable().futureCall(request);
   // Do something.
   for (ListEvaluationResultsResponse.EvaluationResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listEvaluationResultsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsResponse> listEvaluationResultsCallable()

Gets a list of results for a given a [Evaluation][google.cloud.discoveryengine.v1alpha.Evaluation].

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 (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationResultsRequest request =
       ListEvaluationResultsRequest.newBuilder()
           .setEvaluation(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEvaluationResultsResponse response =
         evaluationServiceClient.listEvaluationResultsCallable().call(request);
     for (ListEvaluationResultsResponse.EvaluationResult element :
         response.getEvaluationResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

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