Class EvaluationServiceClient (0.3.0)

GitHub RepositoryProduct ReferenceRPC Documentation

Service Description: EvaluationService exposes methods to perform evaluation for the CES app.

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]", "[APP]", "[EVALUATION]");
   ByteString audioContent = ByteString.EMPTY;
   UploadEvaluationAudioResponse response =
       evaluationServiceClient.uploadEvaluationAudio(name, audioContent);
 }
 

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

RunEvaluation

Runs an evaluation of the app.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • runEvaluationAsync(RunEvaluationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • runEvaluationAsync(AppName app)

  • runEvaluationAsync(String app)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • runEvaluationOperationCallable()

  • runEvaluationCallable()

UploadEvaluationAudio

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • uploadEvaluationAudio(UploadEvaluationAudioRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • uploadEvaluationAudio(EvaluationName name, ByteString audioContent)

  • uploadEvaluationAudio(String name, ByteString audioContent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • uploadEvaluationAudioCallable()

CreateEvaluation

Creates an evaluation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEvaluation(CreateEvaluationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEvaluation(AppName parent, Evaluation evaluation)

  • createEvaluation(String parent, Evaluation evaluation)

  • createEvaluation(AppName parent, Evaluation evaluation, String evaluationId)

  • createEvaluation(String parent, Evaluation evaluation, String evaluationId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEvaluationCallable()

GenerateEvaluation

Creates a golden evaluation from a conversation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • generateEvaluationAsync(GenerateEvaluationRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • generateEvaluationAsync(ConversationName conversation)

  • generateEvaluationAsync(String conversation)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • generateEvaluationOperationCallable()

  • generateEvaluationCallable()

ImportEvaluations

Imports evaluations into the app.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • importEvaluationsAsync(ImportEvaluationsRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • importEvaluationsAsync(AppName parent)

  • importEvaluationsAsync(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.

  • importEvaluationsOperationCallable()

  • importEvaluationsCallable()

CreateEvaluationDataset

Creates an evaluation dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEvaluationDataset(CreateEvaluationDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEvaluationDataset(AppName parent, EvaluationDataset evaluationDataset)

  • createEvaluationDataset(String parent, EvaluationDataset evaluationDataset)

  • createEvaluationDataset(AppName parent, EvaluationDataset evaluationDataset, String evaluationDatasetId)

  • createEvaluationDataset(String parent, EvaluationDataset evaluationDataset, String evaluationDatasetId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEvaluationDatasetCallable()

UpdateEvaluation

Updates an evaluation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEvaluation(UpdateEvaluationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEvaluation(Evaluation evaluation, 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.

  • updateEvaluationCallable()

UpdateEvaluationDataset

Updates an evaluation dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEvaluationDataset(UpdateEvaluationDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEvaluationDataset(EvaluationDataset evaluationDataset, 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.

  • updateEvaluationDatasetCallable()

DeleteEvaluation

Deletes an evaluation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEvaluation(DeleteEvaluationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEvaluation(EvaluationName name)

  • deleteEvaluation(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.

  • deleteEvaluationCallable()

DeleteEvaluationResult

Deletes an evaluation result.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEvaluationResult(DeleteEvaluationResultRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEvaluationResult(EvaluationResultName name)

  • deleteEvaluationResult(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.

  • deleteEvaluationResultCallable()

DeleteEvaluationDataset

Deletes an evaluation dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEvaluationDataset(DeleteEvaluationDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEvaluationDataset(EvaluationDatasetName name)

  • deleteEvaluationDataset(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.

  • deleteEvaluationDatasetCallable()

DeleteEvaluationRun

Deletes an evaluation run.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEvaluationRunAsync(DeleteEvaluationRunRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteEvaluationRunAsync(EvaluationRunName name)

  • deleteEvaluationRunAsync(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.

  • deleteEvaluationRunOperationCallable()

  • deleteEvaluationRunCallable()

GetEvaluation

Gets details of the specified 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()

GetEvaluationResult

Gets details of the specified evaluation result.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEvaluationResult(GetEvaluationResultRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEvaluationResult(EvaluationResultName name)

  • getEvaluationResult(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.

  • getEvaluationResultCallable()

GetEvaluationDataset

Gets details of the specified evaluation dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEvaluationDataset(GetEvaluationDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEvaluationDataset(EvaluationDatasetName name)

  • getEvaluationDataset(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.

  • getEvaluationDatasetCallable()

GetEvaluationRun

Gets details of the specified evaluation run.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEvaluationRun(GetEvaluationRunRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEvaluationRun(EvaluationRunName name)

  • getEvaluationRun(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.

  • getEvaluationRunCallable()

ListEvaluations

Lists all evaluations in the given app.

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(AppName 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()

ListEvaluationResults

Lists all evaluation results for a given 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 parent)

  • listEvaluationResults(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.

  • listEvaluationResultsPagedCallable()

  • listEvaluationResultsCallable()

ListEvaluationDatasets

Lists all evaluation datasets in the given app.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEvaluationDatasets(ListEvaluationDatasetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEvaluationDatasets(AppName parent)

  • listEvaluationDatasets(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.

  • listEvaluationDatasetsPagedCallable()

  • listEvaluationDatasetsCallable()

ListEvaluationRuns

Lists all evaluation runs in the given app.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEvaluationRuns(ListEvaluationRunsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEvaluationRuns(AppName parent)

  • listEvaluationRuns(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.

  • listEvaluationRunsPagedCallable()

  • listEvaluationRunsCallable()

ListEvaluationExpectations

Lists all evaluation expectations in the given app.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEvaluationExpectations(ListEvaluationExpectationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEvaluationExpectations(AppName parent)

  • listEvaluationExpectations(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.

  • listEvaluationExpectationsPagedCallable()

  • listEvaluationExpectationsCallable()

GetEvaluationExpectation

Gets details of the specified evaluation expectation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEvaluationExpectation(GetEvaluationExpectationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEvaluationExpectation(EvaluationExpectationName name)

  • getEvaluationExpectation(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.

  • getEvaluationExpectationCallable()

CreateEvaluationExpectation

Creates an evaluation expectation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEvaluationExpectation(CreateEvaluationExpectationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEvaluationExpectation(AppName parent, EvaluationExpectation evaluationExpectation)

  • createEvaluationExpectation(String parent, EvaluationExpectation evaluationExpectation)

  • createEvaluationExpectation(AppName parent, EvaluationExpectation evaluationExpectation, String evaluationExpectationId)

  • createEvaluationExpectation(String parent, EvaluationExpectation evaluationExpectation, String evaluationExpectationId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEvaluationExpectationCallable()

UpdateEvaluationExpectation

Updates an evaluation expectation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEvaluationExpectation(UpdateEvaluationExpectationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEvaluationExpectation(EvaluationExpectation evaluationExpectation, 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.

  • updateEvaluationExpectationCallable()

DeleteEvaluationExpectation

Deletes an evaluation expectation.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEvaluationExpectation(EvaluationExpectationName name)

  • deleteEvaluationExpectation(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.

  • deleteEvaluationExpectationCallable()

CreateScheduledEvaluationRun

Creates a scheduled evaluation run.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createScheduledEvaluationRun(AppName parent, ScheduledEvaluationRun scheduledEvaluationRun)

  • createScheduledEvaluationRun(String parent, ScheduledEvaluationRun scheduledEvaluationRun)

  • createScheduledEvaluationRun(AppName parent, ScheduledEvaluationRun scheduledEvaluationRun, String scheduledEvaluationRunId)

  • createScheduledEvaluationRun(String parent, ScheduledEvaluationRun scheduledEvaluationRun, String scheduledEvaluationRunId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createScheduledEvaluationRunCallable()

GetScheduledEvaluationRun

Gets details of the specified scheduled evaluation run.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getScheduledEvaluationRun(ScheduledEvaluationRunName name)

  • getScheduledEvaluationRun(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.

  • getScheduledEvaluationRunCallable()

ListScheduledEvaluationRuns

Lists all scheduled evaluation runs in the given app.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listScheduledEvaluationRuns(AppName parent)

  • listScheduledEvaluationRuns(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.

  • listScheduledEvaluationRunsPagedCallable()

  • listScheduledEvaluationRunsCallable()

UpdateScheduledEvaluationRun

Updates a scheduled evaluation run.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateScheduledEvaluationRun(ScheduledEvaluationRun scheduledEvaluationRun, 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.

  • updateScheduledEvaluationRunCallable()

DeleteScheduledEvaluationRun

Deletes a scheduled evaluation run.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteScheduledEvaluationRun(ScheduledEvaluationRunName name)

  • deleteScheduledEvaluationRun(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.

  • deleteScheduledEvaluationRunCallable()

TestPersonaVoice

Tests the voice of a persona. Also accepts a default persona.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testPersonaVoice(TestPersonaVoiceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • testPersonaVoice(AppName app)

  • testPersonaVoice(String app)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testPersonaVoiceCallable()

ListLocations

Lists information about the supported locations for this service.This method can be called in two ways:

* **List all public locations:** Use the path GET /v1/locations.* **List project-visible locations:** Use the pathGET /v1/projects/{project_id}/locations. This may include publiclocations as well as private or other locations specifically visibleto the project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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.

Inheritance

java.lang.Object > EvaluationServiceClient

Static Methods

create()

public static final EvaluationServiceClient create()

Constructs an instance of EvaluationServiceClient with default settings.

Returns
Type Description
EvaluationServiceClient
Exceptions
Type Description
IOException

create(EvaluationServiceSettings settings)

public static final EvaluationServiceClient create(EvaluationServiceSettings settings)

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.

Parameter
Name Description
settings EvaluationServiceSettings
Returns
Type Description
EvaluationServiceClient
Exceptions
Type Description
IOException

create(EvaluationServiceStub stub)

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

Parameter
Name Description
stub EvaluationServiceStub
Returns
Type Description
EvaluationServiceClient

Constructors

EvaluationServiceClient(EvaluationServiceSettings settings)

protected EvaluationServiceClient(EvaluationServiceSettings settings)

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.

Parameter
Name Description
settings EvaluationServiceSettings

EvaluationServiceClient(EvaluationServiceStub stub)

protected EvaluationServiceClient(EvaluationServiceStub stub)
Parameter
Name Description
stub EvaluationServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createEvaluation(AppName parent, Evaluation evaluation)

public final Evaluation createEvaluation(AppName parent, Evaluation evaluation)

Creates an 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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   Evaluation evaluation = Evaluation.newBuilder().build();
   Evaluation response = evaluationServiceClient.createEvaluation(parent, evaluation);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluation Evaluation

Required. The evaluation to create.

Returns
Type Description
Evaluation

createEvaluation(AppName parent, Evaluation evaluation, String evaluationId)

public final Evaluation createEvaluation(AppName parent, Evaluation evaluation, String evaluationId)

Creates an 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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   Evaluation evaluation = Evaluation.newBuilder().build();
   String evaluationId = "evaluationId407318903";
   Evaluation response =
       evaluationServiceClient.createEvaluation(parent, evaluation, evaluationId);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluation Evaluation

Required. The evaluation to create.

evaluationId String

Optional. The ID to use for the evaluation, which will become the final component of the evaluation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

Returns
Type Description
Evaluation

createEvaluation(CreateEvaluationRequest request)

public final Evaluation createEvaluation(CreateEvaluationRequest request)

Creates an 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()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setEvaluationId("evaluationId407318903")
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   Evaluation response = evaluationServiceClient.createEvaluation(request);
 }
 
Parameter
Name Description
request CreateEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Evaluation

createEvaluation(String parent, Evaluation evaluation)

public final Evaluation createEvaluation(String parent, Evaluation evaluation)

Creates an 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 parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   Evaluation evaluation = Evaluation.newBuilder().build();
   Evaluation response = evaluationServiceClient.createEvaluation(parent, evaluation);
 }
 
Parameters
Name Description
parent String

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluation Evaluation

Required. The evaluation to create.

Returns
Type Description
Evaluation

createEvaluation(String parent, Evaluation evaluation, String evaluationId)

public final Evaluation createEvaluation(String parent, Evaluation evaluation, String evaluationId)

Creates an 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 parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   Evaluation evaluation = Evaluation.newBuilder().build();
   String evaluationId = "evaluationId407318903";
   Evaluation response =
       evaluationServiceClient.createEvaluation(parent, evaluation, evaluationId);
 }
 
Parameters
Name Description
parent String

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluation Evaluation

Required. The evaluation to create.

evaluationId String

Optional. The ID to use for the evaluation, which will become the final component of the evaluation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

Returns
Type Description
Evaluation

createEvaluationCallable()

public final UnaryCallable<CreateEvaluationRequest,Evaluation> createEvaluationCallable()

Creates an 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()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setEvaluationId("evaluationId407318903")
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.createEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateEvaluationRequest,Evaluation>

createEvaluationDataset(AppName parent, EvaluationDataset evaluationDataset)

public final EvaluationDataset createEvaluationDataset(AppName parent, EvaluationDataset evaluationDataset)

Creates an evaluation dataset.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   EvaluationDataset evaluationDataset = EvaluationDataset.newBuilder().build();
   EvaluationDataset response =
       evaluationServiceClient.createEvaluationDataset(parent, evaluationDataset);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationDataset EvaluationDataset

Required. The evaluation dataset to create.

Returns
Type Description
EvaluationDataset

createEvaluationDataset(AppName parent, EvaluationDataset evaluationDataset, String evaluationDatasetId)

public final EvaluationDataset createEvaluationDataset(AppName parent, EvaluationDataset evaluationDataset, String evaluationDatasetId)

Creates an evaluation dataset.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   EvaluationDataset evaluationDataset = EvaluationDataset.newBuilder().build();
   String evaluationDatasetId = "evaluationDatasetId1149172695";
   EvaluationDataset response =
       evaluationServiceClient.createEvaluationDataset(
           parent, evaluationDataset, evaluationDatasetId);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationDataset EvaluationDataset

Required. The evaluation dataset to create.

evaluationDatasetId String

Optional. The ID to use for the evaluation dataset, which will become the final component of the evaluation dataset's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

Returns
Type Description
EvaluationDataset

createEvaluationDataset(CreateEvaluationDatasetRequest request)

public final EvaluationDataset createEvaluationDataset(CreateEvaluationDatasetRequest request)

Creates an evaluation dataset.

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()) {
   CreateEvaluationDatasetRequest request =
       CreateEvaluationDatasetRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setEvaluationDatasetId("evaluationDatasetId1149172695")
           .setEvaluationDataset(EvaluationDataset.newBuilder().build())
           .build();
   EvaluationDataset response = evaluationServiceClient.createEvaluationDataset(request);
 }
 
Parameter
Name Description
request CreateEvaluationDatasetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationDataset

createEvaluationDataset(String parent, EvaluationDataset evaluationDataset)

public final EvaluationDataset createEvaluationDataset(String parent, EvaluationDataset evaluationDataset)

Creates an evaluation dataset.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   EvaluationDataset evaluationDataset = EvaluationDataset.newBuilder().build();
   EvaluationDataset response =
       evaluationServiceClient.createEvaluationDataset(parent, evaluationDataset);
 }
 
Parameters
Name Description
parent String

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationDataset EvaluationDataset

Required. The evaluation dataset to create.

Returns
Type Description
EvaluationDataset

createEvaluationDataset(String parent, EvaluationDataset evaluationDataset, String evaluationDatasetId)

public final EvaluationDataset createEvaluationDataset(String parent, EvaluationDataset evaluationDataset, String evaluationDatasetId)

Creates an evaluation dataset.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   EvaluationDataset evaluationDataset = EvaluationDataset.newBuilder().build();
   String evaluationDatasetId = "evaluationDatasetId1149172695";
   EvaluationDataset response =
       evaluationServiceClient.createEvaluationDataset(
           parent, evaluationDataset, evaluationDatasetId);
 }
 
Parameters
Name Description
parent String

Required. The app to create the evaluation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationDataset EvaluationDataset

Required. The evaluation dataset to create.

evaluationDatasetId String

Optional. The ID to use for the evaluation dataset, which will become the final component of the evaluation dataset's resource name. If not provided, a unique ID will be automatically assigned for the evaluation.

Returns
Type Description
EvaluationDataset

createEvaluationDatasetCallable()

public final UnaryCallable<CreateEvaluationDatasetRequest,EvaluationDataset> createEvaluationDatasetCallable()

Creates an evaluation dataset.

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()) {
   CreateEvaluationDatasetRequest request =
       CreateEvaluationDatasetRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setEvaluationDatasetId("evaluationDatasetId1149172695")
           .setEvaluationDataset(EvaluationDataset.newBuilder().build())
           .build();
   ApiFuture<EvaluationDataset> future =
       evaluationServiceClient.createEvaluationDatasetCallable().futureCall(request);
   // Do something.
   EvaluationDataset response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateEvaluationDatasetRequest,EvaluationDataset>

createEvaluationExpectation(AppName parent, EvaluationExpectation evaluationExpectation)

public final EvaluationExpectation createEvaluationExpectation(AppName parent, EvaluationExpectation evaluationExpectation)

Creates an evaluation expectation.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   EvaluationExpectation evaluationExpectation = EvaluationExpectation.newBuilder().build();
   EvaluationExpectation response =
       evaluationServiceClient.createEvaluationExpectation(parent, evaluationExpectation);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the evaluation expectation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationExpectation EvaluationExpectation

Required. The evaluation expectation to create.

Returns
Type Description
EvaluationExpectation

createEvaluationExpectation(AppName parent, EvaluationExpectation evaluationExpectation, String evaluationExpectationId)

public final EvaluationExpectation createEvaluationExpectation(AppName parent, EvaluationExpectation evaluationExpectation, String evaluationExpectationId)

Creates an evaluation expectation.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   EvaluationExpectation evaluationExpectation = EvaluationExpectation.newBuilder().build();
   String evaluationExpectationId = "evaluationExpectationId-31829349";
   EvaluationExpectation response =
       evaluationServiceClient.createEvaluationExpectation(
           parent, evaluationExpectation, evaluationExpectationId);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the evaluation expectation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationExpectation EvaluationExpectation

Required. The evaluation expectation to create.

evaluationExpectationId String

Optional. The ID to use for the evaluation expectation, which will become the final component of the evaluation expectation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation expectation.

Returns
Type Description
EvaluationExpectation

createEvaluationExpectation(CreateEvaluationExpectationRequest request)

public final EvaluationExpectation createEvaluationExpectation(CreateEvaluationExpectationRequest request)

Creates an evaluation expectation.

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()) {
   CreateEvaluationExpectationRequest request =
       CreateEvaluationExpectationRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setEvaluationExpectationId("evaluationExpectationId-31829349")
           .setEvaluationExpectation(EvaluationExpectation.newBuilder().build())
           .build();
   EvaluationExpectation response = evaluationServiceClient.createEvaluationExpectation(request);
 }
 
Parameter
Name Description
request CreateEvaluationExpectationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationExpectation

createEvaluationExpectation(String parent, EvaluationExpectation evaluationExpectation)

public final EvaluationExpectation createEvaluationExpectation(String parent, EvaluationExpectation evaluationExpectation)

Creates an evaluation expectation.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   EvaluationExpectation evaluationExpectation = EvaluationExpectation.newBuilder().build();
   EvaluationExpectation response =
       evaluationServiceClient.createEvaluationExpectation(parent, evaluationExpectation);
 }
 
Parameters
Name Description
parent String

Required. The app to create the evaluation expectation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationExpectation EvaluationExpectation

Required. The evaluation expectation to create.

Returns
Type Description
EvaluationExpectation

createEvaluationExpectation(String parent, EvaluationExpectation evaluationExpectation, String evaluationExpectationId)

public final EvaluationExpectation createEvaluationExpectation(String parent, EvaluationExpectation evaluationExpectation, String evaluationExpectationId)

Creates an evaluation expectation.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   EvaluationExpectation evaluationExpectation = EvaluationExpectation.newBuilder().build();
   String evaluationExpectationId = "evaluationExpectationId-31829349";
   EvaluationExpectation response =
       evaluationServiceClient.createEvaluationExpectation(
           parent, evaluationExpectation, evaluationExpectationId);
 }
 
Parameters
Name Description
parent String

Required. The app to create the evaluation expectation for. Format: projects/{project}/locations/{location}/apps/{app}

evaluationExpectation EvaluationExpectation

Required. The evaluation expectation to create.

evaluationExpectationId String

Optional. The ID to use for the evaluation expectation, which will become the final component of the evaluation expectation's resource name. If not provided, a unique ID will be automatically assigned for the evaluation expectation.

Returns
Type Description
EvaluationExpectation

createEvaluationExpectationCallable()

public final UnaryCallable<CreateEvaluationExpectationRequest,EvaluationExpectation> createEvaluationExpectationCallable()

Creates an evaluation expectation.

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()) {
   CreateEvaluationExpectationRequest request =
       CreateEvaluationExpectationRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setEvaluationExpectationId("evaluationExpectationId-31829349")
           .setEvaluationExpectation(EvaluationExpectation.newBuilder().build())
           .build();
   ApiFuture<EvaluationExpectation> future =
       evaluationServiceClient.createEvaluationExpectationCallable().futureCall(request);
   // Do something.
   EvaluationExpectation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateEvaluationExpectationRequest,EvaluationExpectation>

createScheduledEvaluationRun(AppName parent, ScheduledEvaluationRun scheduledEvaluationRun)

public final ScheduledEvaluationRun createScheduledEvaluationRun(AppName parent, ScheduledEvaluationRun scheduledEvaluationRun)

Creates a scheduled evaluation run.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   ScheduledEvaluationRun scheduledEvaluationRun = ScheduledEvaluationRun.newBuilder().build();
   ScheduledEvaluationRun response =
       evaluationServiceClient.createScheduledEvaluationRun(parent, scheduledEvaluationRun);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the scheduled evaluation run for. Format: projects/{project}/locations/{location}/apps/{app}

scheduledEvaluationRun ScheduledEvaluationRun

Required. The scheduled evaluation run to create.

Returns
Type Description
ScheduledEvaluationRun

createScheduledEvaluationRun(AppName parent, ScheduledEvaluationRun scheduledEvaluationRun, String scheduledEvaluationRunId)

public final ScheduledEvaluationRun createScheduledEvaluationRun(AppName parent, ScheduledEvaluationRun scheduledEvaluationRun, String scheduledEvaluationRunId)

Creates a scheduled evaluation run.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   ScheduledEvaluationRun scheduledEvaluationRun = ScheduledEvaluationRun.newBuilder().build();
   String scheduledEvaluationRunId = "scheduledEvaluationRunId-434150723";
   ScheduledEvaluationRun response =
       evaluationServiceClient.createScheduledEvaluationRun(
           parent, scheduledEvaluationRun, scheduledEvaluationRunId);
 }
 
Parameters
Name Description
parent AppName

Required. The app to create the scheduled evaluation run for. Format: projects/{project}/locations/{location}/apps/{app}

scheduledEvaluationRun ScheduledEvaluationRun

Required. The scheduled evaluation run to create.

scheduledEvaluationRunId String

Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.

Returns
Type Description
ScheduledEvaluationRun

createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request)

public final ScheduledEvaluationRun createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request)

Creates a scheduled evaluation run.

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()) {
   CreateScheduledEvaluationRunRequest request =
       CreateScheduledEvaluationRunRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setScheduledEvaluationRunId("scheduledEvaluationRunId-434150723")
           .setScheduledEvaluationRun(ScheduledEvaluationRun.newBuilder().build())
           .build();
   ScheduledEvaluationRun response =
       evaluationServiceClient.createScheduledEvaluationRun(request);
 }
 
Parameter
Name Description
request CreateScheduledEvaluationRunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ScheduledEvaluationRun

createScheduledEvaluationRun(String parent, ScheduledEvaluationRun scheduledEvaluationRun)

public final ScheduledEvaluationRun createScheduledEvaluationRun(String parent, ScheduledEvaluationRun scheduledEvaluationRun)

Creates a scheduled evaluation run.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   ScheduledEvaluationRun scheduledEvaluationRun = ScheduledEvaluationRun.newBuilder().build();
   ScheduledEvaluationRun response =
       evaluationServiceClient.createScheduledEvaluationRun(parent, scheduledEvaluationRun);
 }
 
Parameters
Name Description
parent String

Required. The app to create the scheduled evaluation run for. Format: projects/{project}/locations/{location}/apps/{app}

scheduledEvaluationRun ScheduledEvaluationRun

Required. The scheduled evaluation run to create.

Returns
Type Description
ScheduledEvaluationRun

createScheduledEvaluationRun(String parent, ScheduledEvaluationRun scheduledEvaluationRun, String scheduledEvaluationRunId)

public final ScheduledEvaluationRun createScheduledEvaluationRun(String parent, ScheduledEvaluationRun scheduledEvaluationRun, String scheduledEvaluationRunId)

Creates a scheduled evaluation run.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   ScheduledEvaluationRun scheduledEvaluationRun = ScheduledEvaluationRun.newBuilder().build();
   String scheduledEvaluationRunId = "scheduledEvaluationRunId-434150723";
   ScheduledEvaluationRun response =
       evaluationServiceClient.createScheduledEvaluationRun(
           parent, scheduledEvaluationRun, scheduledEvaluationRunId);
 }
 
Parameters
Name Description
parent String

Required. The app to create the scheduled evaluation run for. Format: projects/{project}/locations/{location}/apps/{app}

scheduledEvaluationRun ScheduledEvaluationRun

Required. The scheduled evaluation run to create.

scheduledEvaluationRunId String

Optional. The ID to use for the scheduled evaluation run, which will become the final component of the scheduled evaluation run's resource name. If not provided, a unique ID will be automatically assigned.

Returns
Type Description
ScheduledEvaluationRun

createScheduledEvaluationRunCallable()

public final UnaryCallable<CreateScheduledEvaluationRunRequest,ScheduledEvaluationRun> createScheduledEvaluationRunCallable()

Creates a scheduled evaluation run.

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()) {
   CreateScheduledEvaluationRunRequest request =
       CreateScheduledEvaluationRunRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setScheduledEvaluationRunId("scheduledEvaluationRunId-434150723")
           .setScheduledEvaluationRun(ScheduledEvaluationRun.newBuilder().build())
           .build();
   ApiFuture<ScheduledEvaluationRun> future =
       evaluationServiceClient.createScheduledEvaluationRunCallable().futureCall(request);
   // Do something.
   ScheduledEvaluationRun response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateScheduledEvaluationRunRequest,ScheduledEvaluationRun>

deleteEvaluation(DeleteEvaluationRequest request)

public final void deleteEvaluation(DeleteEvaluationRequest request)

Deletes an 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()) {
   DeleteEvaluationRequest request =
       DeleteEvaluationRequest.newBuilder()
           .setName(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setForce(true)
           .setEtag("etag3123477")
           .build();
   evaluationServiceClient.deleteEvaluation(request);
 }
 
Parameter
Name Description
request DeleteEvaluationRequest

The request object containing all of the parameters for the API call.

deleteEvaluation(EvaluationName name)

public final void deleteEvaluation(EvaluationName name)

Deletes an 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]", "[APP]", "[EVALUATION]");
   evaluationServiceClient.deleteEvaluation(name);
 }
 
Parameter
Name Description
name EvaluationName

Required. The resource name of the evaluation to delete.

deleteEvaluation(String name)

public final void deleteEvaluation(String name)

Deletes an 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]", "[APP]", "[EVALUATION]").toString();
   evaluationServiceClient.deleteEvaluation(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation to delete.

deleteEvaluationCallable()

public final UnaryCallable<DeleteEvaluationRequest,Empty> deleteEvaluationCallable()

Deletes an 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()) {
   DeleteEvaluationRequest request =
       DeleteEvaluationRequest.newBuilder()
           .setName(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setForce(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       evaluationServiceClient.deleteEvaluationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEvaluationRequest,Empty>

deleteEvaluationDataset(DeleteEvaluationDatasetRequest request)

public final void deleteEvaluationDataset(DeleteEvaluationDatasetRequest request)

Deletes an evaluation dataset.

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()) {
   DeleteEvaluationDatasetRequest request =
       DeleteEvaluationDatasetRequest.newBuilder()
           .setName(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   evaluationServiceClient.deleteEvaluationDataset(request);
 }
 
Parameter
Name Description
request DeleteEvaluationDatasetRequest

The request object containing all of the parameters for the API call.

deleteEvaluationDataset(EvaluationDatasetName name)

public final void deleteEvaluationDataset(EvaluationDatasetName name)

Deletes an evaluation dataset.

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()) {
   EvaluationDatasetName name =
       EvaluationDatasetName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]");
   evaluationServiceClient.deleteEvaluationDataset(name);
 }
 
Parameter
Name Description
name EvaluationDatasetName

Required. The resource name of the evaluation dataset to delete.

deleteEvaluationDataset(String name)

public final void deleteEvaluationDataset(String name)

Deletes an evaluation dataset.

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 =
       EvaluationDatasetName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
           .toString();
   evaluationServiceClient.deleteEvaluationDataset(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation dataset to delete.

deleteEvaluationDatasetCallable()

public final UnaryCallable<DeleteEvaluationDatasetRequest,Empty> deleteEvaluationDatasetCallable()

Deletes an evaluation dataset.

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()) {
   DeleteEvaluationDatasetRequest request =
       DeleteEvaluationDatasetRequest.newBuilder()
           .setName(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       evaluationServiceClient.deleteEvaluationDatasetCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEvaluationDatasetRequest,Empty>

deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request)

public final void deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request)

Deletes an evaluation expectation.

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()) {
   DeleteEvaluationExpectationRequest request =
       DeleteEvaluationExpectationRequest.newBuilder()
           .setName(
               EvaluationExpectationName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   evaluationServiceClient.deleteEvaluationExpectation(request);
 }
 
Parameter
Name Description
request DeleteEvaluationExpectationRequest

The request object containing all of the parameters for the API call.

deleteEvaluationExpectation(EvaluationExpectationName name)

public final void deleteEvaluationExpectation(EvaluationExpectationName name)

Deletes an evaluation expectation.

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()) {
   EvaluationExpectationName name =
       EvaluationExpectationName.of(
           "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]");
   evaluationServiceClient.deleteEvaluationExpectation(name);
 }
 
Parameter
Name Description
name EvaluationExpectationName

Required. The resource name of the evaluation expectation to delete.

deleteEvaluationExpectation(String name)

public final void deleteEvaluationExpectation(String name)

Deletes an evaluation expectation.

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 =
       EvaluationExpectationName.of(
               "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]")
           .toString();
   evaluationServiceClient.deleteEvaluationExpectation(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation expectation to delete.

deleteEvaluationExpectationCallable()

public final UnaryCallable<DeleteEvaluationExpectationRequest,Empty> deleteEvaluationExpectationCallable()

Deletes an evaluation expectation.

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()) {
   DeleteEvaluationExpectationRequest request =
       DeleteEvaluationExpectationRequest.newBuilder()
           .setName(
               EvaluationExpectationName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       evaluationServiceClient.deleteEvaluationExpectationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEvaluationExpectationRequest,Empty>

deleteEvaluationResult(DeleteEvaluationResultRequest request)

public final void deleteEvaluationResult(DeleteEvaluationResultRequest request)

Deletes an evaluation result.

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()) {
   DeleteEvaluationResultRequest request =
       DeleteEvaluationResultRequest.newBuilder()
           .setName(
               EvaluationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]")
                   .toString())
           .build();
   evaluationServiceClient.deleteEvaluationResult(request);
 }
 
Parameter
Name Description
request DeleteEvaluationResultRequest

The request object containing all of the parameters for the API call.

deleteEvaluationResult(EvaluationResultName name)

public final void deleteEvaluationResult(EvaluationResultName name)

Deletes an evaluation result.

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()) {
   EvaluationResultName name =
       EvaluationResultName.of(
           "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]");
   evaluationServiceClient.deleteEvaluationResult(name);
 }
 
Parameter
Name Description
name EvaluationResultName

Required. The resource name of the evaluation result to delete.

deleteEvaluationResult(String name)

public final void deleteEvaluationResult(String name)

Deletes an evaluation result.

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 =
       EvaluationResultName.of(
               "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]")
           .toString();
   evaluationServiceClient.deleteEvaluationResult(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation result to delete.

deleteEvaluationResultCallable()

public final UnaryCallable<DeleteEvaluationResultRequest,Empty> deleteEvaluationResultCallable()

Deletes an evaluation result.

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()) {
   DeleteEvaluationResultRequest request =
       DeleteEvaluationResultRequest.newBuilder()
           .setName(
               EvaluationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       evaluationServiceClient.deleteEvaluationResultCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEvaluationResultRequest,Empty>

deleteEvaluationRunAsync(DeleteEvaluationRunRequest request)

public final OperationFuture<Empty,DeleteEvaluationRunOperationMetadata> deleteEvaluationRunAsync(DeleteEvaluationRunRequest request)

Deletes an evaluation run.

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()) {
   DeleteEvaluationRunRequest request =
       DeleteEvaluationRunRequest.newBuilder()
           .setName(
               EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]")
                   .toString())
           .build();
   evaluationServiceClient.deleteEvaluationRunAsync(request).get();
 }
 
Parameter
Name Description
request DeleteEvaluationRunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Empty,DeleteEvaluationRunOperationMetadata>

deleteEvaluationRunAsync(EvaluationRunName name)

public final OperationFuture<Empty,DeleteEvaluationRunOperationMetadata> deleteEvaluationRunAsync(EvaluationRunName name)

Deletes an evaluation run.

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()) {
   EvaluationRunName name =
       EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]");
   evaluationServiceClient.deleteEvaluationRunAsync(name).get();
 }
 
Parameter
Name Description
name EvaluationRunName

Required. The resource name of the evaluation run to delete.

Returns
Type Description
OperationFuture<Empty,DeleteEvaluationRunOperationMetadata>

deleteEvaluationRunAsync(String name)

public final OperationFuture<Empty,DeleteEvaluationRunOperationMetadata> deleteEvaluationRunAsync(String name)

Deletes an evaluation run.

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 =
       EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]").toString();
   evaluationServiceClient.deleteEvaluationRunAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation run to delete.

Returns
Type Description
OperationFuture<Empty,DeleteEvaluationRunOperationMetadata>

deleteEvaluationRunCallable()

public final UnaryCallable<DeleteEvaluationRunRequest,Operation> deleteEvaluationRunCallable()

Deletes an evaluation run.

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()) {
   DeleteEvaluationRunRequest request =
       DeleteEvaluationRunRequest.newBuilder()
           .setName(
               EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       evaluationServiceClient.deleteEvaluationRunCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteEvaluationRunRequest,Operation>

deleteEvaluationRunOperationCallable()

public final OperationCallable<DeleteEvaluationRunRequest,Empty,DeleteEvaluationRunOperationMetadata> deleteEvaluationRunOperationCallable()

Deletes an evaluation run.

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()) {
   DeleteEvaluationRunRequest request =
       DeleteEvaluationRunRequest.newBuilder()
           .setName(
               EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteEvaluationRunOperationMetadata> future =
       evaluationServiceClient.deleteEvaluationRunOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteEvaluationRunRequest,Empty,DeleteEvaluationRunOperationMetadata>

deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request)

public final void deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request)

Deletes a scheduled evaluation run.

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()) {
   DeleteScheduledEvaluationRunRequest request =
       DeleteScheduledEvaluationRunRequest.newBuilder()
           .setName(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   evaluationServiceClient.deleteScheduledEvaluationRun(request);
 }
 
Parameter
Name Description
request DeleteScheduledEvaluationRunRequest

The request object containing all of the parameters for the API call.

deleteScheduledEvaluationRun(ScheduledEvaluationRunName name)

public final void deleteScheduledEvaluationRun(ScheduledEvaluationRunName name)

Deletes a scheduled evaluation run.

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()) {
   ScheduledEvaluationRunName name =
       ScheduledEvaluationRunName.of(
           "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]");
   evaluationServiceClient.deleteScheduledEvaluationRun(name);
 }
 
Parameter
Name Description
name ScheduledEvaluationRunName

Required. The resource name of the scheduled evaluation run to delete.

deleteScheduledEvaluationRun(String name)

public final void deleteScheduledEvaluationRun(String name)

Deletes a scheduled evaluation run.

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 =
       ScheduledEvaluationRunName.of(
               "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
           .toString();
   evaluationServiceClient.deleteScheduledEvaluationRun(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the scheduled evaluation run to delete.

deleteScheduledEvaluationRunCallable()

public final UnaryCallable<DeleteScheduledEvaluationRunRequest,Empty> deleteScheduledEvaluationRunCallable()

Deletes a scheduled evaluation run.

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()) {
   DeleteScheduledEvaluationRunRequest request =
       DeleteScheduledEvaluationRunRequest.newBuilder()
           .setName(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Empty> future =
       evaluationServiceClient.deleteScheduledEvaluationRunCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteScheduledEvaluationRunRequest,Empty>

generateEvaluationAsync(ConversationName conversation)

public final OperationFuture<Evaluation,GenerateEvaluationOperationMetadata> generateEvaluationAsync(ConversationName conversation)

Creates a golden evaluation from a conversation.

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()) {
   ConversationName conversation =
       ConversationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[CONVERSATION]");
   Evaluation response = evaluationServiceClient.generateEvaluationAsync(conversation).get();
 }
 
Parameter
Name Description
conversation ConversationName

Required. The conversation to create the golden evaluation for. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

Returns
Type Description
OperationFuture<Evaluation,GenerateEvaluationOperationMetadata>

generateEvaluationAsync(GenerateEvaluationRequest request)

public final OperationFuture<Evaluation,GenerateEvaluationOperationMetadata> generateEvaluationAsync(GenerateEvaluationRequest request)

Creates a golden evaluation from a conversation.

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()) {
   GenerateEvaluationRequest request =
       GenerateEvaluationRequest.newBuilder()
           .setConversation(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[CONVERSATION]")
                   .toString())
           .build();
   Evaluation response = evaluationServiceClient.generateEvaluationAsync(request).get();
 }
 
Parameter
Name Description
request GenerateEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<Evaluation,GenerateEvaluationOperationMetadata>

generateEvaluationAsync(String conversation)

public final OperationFuture<Evaluation,GenerateEvaluationOperationMetadata> generateEvaluationAsync(String conversation)

Creates a golden evaluation from a conversation.

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 conversation =
       ConversationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[CONVERSATION]").toString();
   Evaluation response = evaluationServiceClient.generateEvaluationAsync(conversation).get();
 }
 
Parameter
Name Description
conversation String

Required. The conversation to create the golden evaluation for. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}

Returns
Type Description
OperationFuture<Evaluation,GenerateEvaluationOperationMetadata>

generateEvaluationCallable()

public final UnaryCallable<GenerateEvaluationRequest,Operation> generateEvaluationCallable()

Creates a golden evaluation from a conversation.

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()) {
   GenerateEvaluationRequest request =
       GenerateEvaluationRequest.newBuilder()
           .setConversation(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[CONVERSATION]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       evaluationServiceClient.generateEvaluationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GenerateEvaluationRequest,Operation>

generateEvaluationOperationCallable()

public final OperationCallable<GenerateEvaluationRequest,Evaluation,GenerateEvaluationOperationMetadata> generateEvaluationOperationCallable()

Creates a golden evaluation from a conversation.

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()) {
   GenerateEvaluationRequest request =
       GenerateEvaluationRequest.newBuilder()
           .setConversation(
               ConversationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[CONVERSATION]")
                   .toString())
           .build();
   OperationFuture<Evaluation, GenerateEvaluationOperationMetadata> future =
       evaluationServiceClient.generateEvaluationOperationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 
Returns
Type Description
OperationCallable<GenerateEvaluationRequest,Evaluation,GenerateEvaluationOperationMetadata>

getEvaluation(EvaluationName name)

public final Evaluation getEvaluation(EvaluationName name)

Gets details of the specified 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]", "[APP]", "[EVALUATION]");
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
 
Parameter
Name Description
name EvaluationName

Required. The resource name of the evaluation to retrieve.

Returns
Type Description
Evaluation

getEvaluation(GetEvaluationRequest request)

public final Evaluation getEvaluation(GetEvaluationRequest request)

Gets details of the specified 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]", "[APP]", "[EVALUATION]").toString())
           .build();
   Evaluation response = evaluationServiceClient.getEvaluation(request);
 }
 
Parameter
Name Description
request GetEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Evaluation

getEvaluation(String name)

public final Evaluation getEvaluation(String name)

Gets details of the specified 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]", "[APP]", "[EVALUATION]").toString();
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation to retrieve.

Returns
Type Description
Evaluation

getEvaluationCallable()

public final UnaryCallable<GetEvaluationRequest,Evaluation> getEvaluationCallable()

Gets details of the specified 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]", "[APP]", "[EVALUATION]").toString())
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.getEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEvaluationRequest,Evaluation>

getEvaluationDataset(EvaluationDatasetName name)

public final EvaluationDataset getEvaluationDataset(EvaluationDatasetName name)

Gets details of the specified evaluation dataset.

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()) {
   EvaluationDatasetName name =
       EvaluationDatasetName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]");
   EvaluationDataset response = evaluationServiceClient.getEvaluationDataset(name);
 }
 
Parameter
Name Description
name EvaluationDatasetName

Required. The resource name of the evaluation dataset to retrieve.

Returns
Type Description
EvaluationDataset

getEvaluationDataset(GetEvaluationDatasetRequest request)

public final EvaluationDataset getEvaluationDataset(GetEvaluationDatasetRequest request)

Gets details of the specified evaluation dataset.

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()) {
   GetEvaluationDatasetRequest request =
       GetEvaluationDatasetRequest.newBuilder()
           .setName(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .build();
   EvaluationDataset response = evaluationServiceClient.getEvaluationDataset(request);
 }
 
Parameter
Name Description
request GetEvaluationDatasetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationDataset

getEvaluationDataset(String name)

public final EvaluationDataset getEvaluationDataset(String name)

Gets details of the specified evaluation dataset.

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 =
       EvaluationDatasetName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
           .toString();
   EvaluationDataset response = evaluationServiceClient.getEvaluationDataset(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation dataset to retrieve.

Returns
Type Description
EvaluationDataset

getEvaluationDatasetCallable()

public final UnaryCallable<GetEvaluationDatasetRequest,EvaluationDataset> getEvaluationDatasetCallable()

Gets details of the specified evaluation dataset.

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()) {
   GetEvaluationDatasetRequest request =
       GetEvaluationDatasetRequest.newBuilder()
           .setName(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .build();
   ApiFuture<EvaluationDataset> future =
       evaluationServiceClient.getEvaluationDatasetCallable().futureCall(request);
   // Do something.
   EvaluationDataset response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEvaluationDatasetRequest,EvaluationDataset>

getEvaluationExpectation(EvaluationExpectationName name)

public final EvaluationExpectation getEvaluationExpectation(EvaluationExpectationName name)

Gets details of the specified evaluation expectation.

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()) {
   EvaluationExpectationName name =
       EvaluationExpectationName.of(
           "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]");
   EvaluationExpectation response = evaluationServiceClient.getEvaluationExpectation(name);
 }
 
Parameter
Name Description
name EvaluationExpectationName

Required. The resource name of the evaluation expectation to retrieve.

Returns
Type Description
EvaluationExpectation

getEvaluationExpectation(GetEvaluationExpectationRequest request)

public final EvaluationExpectation getEvaluationExpectation(GetEvaluationExpectationRequest request)

Gets details of the specified evaluation expectation.

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()) {
   GetEvaluationExpectationRequest request =
       GetEvaluationExpectationRequest.newBuilder()
           .setName(
               EvaluationExpectationName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]")
                   .toString())
           .build();
   EvaluationExpectation response = evaluationServiceClient.getEvaluationExpectation(request);
 }
 
Parameter
Name Description
request GetEvaluationExpectationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationExpectation

getEvaluationExpectation(String name)

public final EvaluationExpectation getEvaluationExpectation(String name)

Gets details of the specified evaluation expectation.

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 =
       EvaluationExpectationName.of(
               "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]")
           .toString();
   EvaluationExpectation response = evaluationServiceClient.getEvaluationExpectation(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation expectation to retrieve.

Returns
Type Description
EvaluationExpectation

getEvaluationExpectationCallable()

public final UnaryCallable<GetEvaluationExpectationRequest,EvaluationExpectation> getEvaluationExpectationCallable()

Gets details of the specified evaluation expectation.

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()) {
   GetEvaluationExpectationRequest request =
       GetEvaluationExpectationRequest.newBuilder()
           .setName(
               EvaluationExpectationName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_EXPECTATION]")
                   .toString())
           .build();
   ApiFuture<EvaluationExpectation> future =
       evaluationServiceClient.getEvaluationExpectationCallable().futureCall(request);
   // Do something.
   EvaluationExpectation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEvaluationExpectationRequest,EvaluationExpectation>

getEvaluationResult(EvaluationResultName name)

public final EvaluationResult getEvaluationResult(EvaluationResultName name)

Gets details of the specified evaluation result.

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()) {
   EvaluationResultName name =
       EvaluationResultName.of(
           "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]");
   EvaluationResult response = evaluationServiceClient.getEvaluationResult(name);
 }
 
Parameter
Name Description
name EvaluationResultName

Required. The resource name of the evaluation result to retrieve.

Returns
Type Description
EvaluationResult

getEvaluationResult(GetEvaluationResultRequest request)

public final EvaluationResult getEvaluationResult(GetEvaluationResultRequest request)

Gets details of the specified evaluation result.

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()) {
   GetEvaluationResultRequest request =
       GetEvaluationResultRequest.newBuilder()
           .setName(
               EvaluationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]")
                   .toString())
           .build();
   EvaluationResult response = evaluationServiceClient.getEvaluationResult(request);
 }
 
Parameter
Name Description
request GetEvaluationResultRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationResult

getEvaluationResult(String name)

public final EvaluationResult getEvaluationResult(String name)

Gets details of the specified evaluation result.

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 =
       EvaluationResultName.of(
               "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]")
           .toString();
   EvaluationResult response = evaluationServiceClient.getEvaluationResult(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation result to retrieve.

Returns
Type Description
EvaluationResult

getEvaluationResultCallable()

public final UnaryCallable<GetEvaluationResultRequest,EvaluationResult> getEvaluationResultCallable()

Gets details of the specified evaluation result.

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()) {
   GetEvaluationResultRequest request =
       GetEvaluationResultRequest.newBuilder()
           .setName(
               EvaluationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]", "[EVALUATION_RESULT]")
                   .toString())
           .build();
   ApiFuture<EvaluationResult> future =
       evaluationServiceClient.getEvaluationResultCallable().futureCall(request);
   // Do something.
   EvaluationResult response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEvaluationResultRequest,EvaluationResult>

getEvaluationRun(EvaluationRunName name)

public final EvaluationRun getEvaluationRun(EvaluationRunName name)

Gets details of the specified evaluation run.

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()) {
   EvaluationRunName name =
       EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]");
   EvaluationRun response = evaluationServiceClient.getEvaluationRun(name);
 }
 
Parameter
Name Description
name EvaluationRunName

Required. The resource name of the evaluation run to retrieve.

Returns
Type Description
EvaluationRun

getEvaluationRun(GetEvaluationRunRequest request)

public final EvaluationRun getEvaluationRun(GetEvaluationRunRequest request)

Gets details of the specified evaluation run.

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()) {
   GetEvaluationRunRequest request =
       GetEvaluationRunRequest.newBuilder()
           .setName(
               EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]")
                   .toString())
           .build();
   EvaluationRun response = evaluationServiceClient.getEvaluationRun(request);
 }
 
Parameter
Name Description
request GetEvaluationRunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationRun

getEvaluationRun(String name)

public final EvaluationRun getEvaluationRun(String name)

Gets details of the specified evaluation run.

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 =
       EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]").toString();
   EvaluationRun response = evaluationServiceClient.getEvaluationRun(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the evaluation run to retrieve.

Returns
Type Description
EvaluationRun

getEvaluationRunCallable()

public final UnaryCallable<GetEvaluationRunRequest,EvaluationRun> getEvaluationRunCallable()

Gets details of the specified evaluation run.

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()) {
   GetEvaluationRunRequest request =
       GetEvaluationRunRequest.newBuilder()
           .setName(
               EvaluationRunName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_RUN]")
                   .toString())
           .build();
   ApiFuture<EvaluationRun> future =
       evaluationServiceClient.getEvaluationRunCallable().futureCall(request);
   // Do something.
   EvaluationRun response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetEvaluationRunRequest,EvaluationRun>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = evaluationServiceClient.getLocation(request);
 }
 
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       evaluationServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request)

public final ScheduledEvaluationRun getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request)

Gets details of the specified scheduled evaluation run.

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()) {
   GetScheduledEvaluationRunRequest request =
       GetScheduledEvaluationRunRequest.newBuilder()
           .setName(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .build();
   ScheduledEvaluationRun response = evaluationServiceClient.getScheduledEvaluationRun(request);
 }
 
Parameter
Name Description
request GetScheduledEvaluationRunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ScheduledEvaluationRun

getScheduledEvaluationRun(ScheduledEvaluationRunName name)

public final ScheduledEvaluationRun getScheduledEvaluationRun(ScheduledEvaluationRunName name)

Gets details of the specified scheduled evaluation run.

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()) {
   ScheduledEvaluationRunName name =
       ScheduledEvaluationRunName.of(
           "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]");
   ScheduledEvaluationRun response = evaluationServiceClient.getScheduledEvaluationRun(name);
 }
 
Parameter
Name Description
name ScheduledEvaluationRunName

Required. The resource name of the scheduled evaluation run to retrieve.

Returns
Type Description
ScheduledEvaluationRun

getScheduledEvaluationRun(String name)

public final ScheduledEvaluationRun getScheduledEvaluationRun(String name)

Gets details of the specified scheduled evaluation run.

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 =
       ScheduledEvaluationRunName.of(
               "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
           .toString();
   ScheduledEvaluationRun response = evaluationServiceClient.getScheduledEvaluationRun(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the scheduled evaluation run to retrieve.

Returns
Type Description
ScheduledEvaluationRun

getScheduledEvaluationRunCallable()

public final UnaryCallable<GetScheduledEvaluationRunRequest,ScheduledEvaluationRun> getScheduledEvaluationRunCallable()

Gets details of the specified scheduled evaluation run.

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()) {
   GetScheduledEvaluationRunRequest request =
       GetScheduledEvaluationRunRequest.newBuilder()
           .setName(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .build();
   ApiFuture<ScheduledEvaluationRun> future =
       evaluationServiceClient.getScheduledEvaluationRunCallable().futureCall(request);
   // Do something.
   ScheduledEvaluationRun response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetScheduledEvaluationRunRequest,ScheduledEvaluationRun>

getSettings()

public final EvaluationServiceSettings getSettings()
Returns
Type Description
EvaluationServiceSettings

getStub()

public EvaluationServiceStub getStub()
Returns
Type Description
EvaluationServiceStub

importEvaluationsAsync(AppName parent)

public final OperationFuture<ImportEvaluationsResponse,ImportEvaluationsOperationMetadata> importEvaluationsAsync(AppName parent)

Imports evaluations into the app.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   ImportEvaluationsResponse response =
       evaluationServiceClient.importEvaluationsAsync(parent).get();
 }
 
Parameter
Name Description
parent AppName

Required. The app to import the evaluations into. Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
OperationFuture<ImportEvaluationsResponse,ImportEvaluationsOperationMetadata>

importEvaluationsAsync(ImportEvaluationsRequest request)

public final OperationFuture<ImportEvaluationsResponse,ImportEvaluationsOperationMetadata> importEvaluationsAsync(ImportEvaluationsRequest request)

Imports evaluations into the app.

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()) {
   ImportEvaluationsRequest request =
       ImportEvaluationsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setImportOptions(ImportEvaluationsRequest.ImportOptions.newBuilder().build())
           .build();
   ImportEvaluationsResponse response =
       evaluationServiceClient.importEvaluationsAsync(request).get();
 }
 
Parameter
Name Description
request ImportEvaluationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<ImportEvaluationsResponse,ImportEvaluationsOperationMetadata>

importEvaluationsAsync(String parent)

public final OperationFuture<ImportEvaluationsResponse,ImportEvaluationsOperationMetadata> importEvaluationsAsync(String parent)

Imports evaluations into the app.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   ImportEvaluationsResponse response =
       evaluationServiceClient.importEvaluationsAsync(parent).get();
 }
 
Parameter
Name Description
parent String

Required. The app to import the evaluations into. Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
OperationFuture<ImportEvaluationsResponse,ImportEvaluationsOperationMetadata>

importEvaluationsCallable()

public final UnaryCallable<ImportEvaluationsRequest,Operation> importEvaluationsCallable()

Imports evaluations into the app.

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()) {
   ImportEvaluationsRequest request =
       ImportEvaluationsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setImportOptions(ImportEvaluationsRequest.ImportOptions.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       evaluationServiceClient.importEvaluationsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<ImportEvaluationsRequest,Operation>

importEvaluationsOperationCallable()

public final OperationCallable<ImportEvaluationsRequest,ImportEvaluationsResponse,ImportEvaluationsOperationMetadata> importEvaluationsOperationCallable()

Imports evaluations into the app.

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()) {
   ImportEvaluationsRequest request =
       ImportEvaluationsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setImportOptions(ImportEvaluationsRequest.ImportOptions.newBuilder().build())
           .build();
   OperationFuture<ImportEvaluationsResponse, ImportEvaluationsOperationMetadata> future =
       evaluationServiceClient.importEvaluationsOperationCallable().futureCall(request);
   // Do something.
   ImportEvaluationsResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<ImportEvaluationsRequest,ImportEvaluationsResponse,ImportEvaluationsOperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listEvaluationDatasets(AppName parent)

public final EvaluationServiceClient.ListEvaluationDatasetsPagedResponse listEvaluationDatasets(AppName parent)

Lists all evaluation datasets in the given app.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   for (EvaluationDataset element :
       evaluationServiceClient.listEvaluationDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent AppName

Required. The resource name of the app to list evaluation datasets from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationDatasetsPagedResponse

listEvaluationDatasets(ListEvaluationDatasetsRequest request)

public final EvaluationServiceClient.ListEvaluationDatasetsPagedResponse listEvaluationDatasets(ListEvaluationDatasetsRequest request)

Lists all evaluation datasets in the given app.

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()) {
   ListEvaluationDatasetsRequest request =
       ListEvaluationDatasetsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EvaluationDataset element :
       evaluationServiceClient.listEvaluationDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEvaluationDatasetsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListEvaluationDatasetsPagedResponse

listEvaluationDatasets(String parent)

public final EvaluationServiceClient.ListEvaluationDatasetsPagedResponse listEvaluationDatasets(String parent)

Lists all evaluation datasets in the given app.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   for (EvaluationDataset element :
       evaluationServiceClient.listEvaluationDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the app to list evaluation datasets from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationDatasetsPagedResponse

listEvaluationDatasetsCallable()

public final UnaryCallable<ListEvaluationDatasetsRequest,ListEvaluationDatasetsResponse> listEvaluationDatasetsCallable()

Lists all evaluation datasets in the given app.

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()) {
   ListEvaluationDatasetsRequest request =
       ListEvaluationDatasetsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEvaluationDatasetsResponse response =
         evaluationServiceClient.listEvaluationDatasetsCallable().call(request);
     for (EvaluationDataset element : response.getEvaluationDatasetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationDatasetsRequest,ListEvaluationDatasetsResponse>

listEvaluationDatasetsPagedCallable()

public final UnaryCallable<ListEvaluationDatasetsRequest,EvaluationServiceClient.ListEvaluationDatasetsPagedResponse> listEvaluationDatasetsPagedCallable()

Lists all evaluation datasets in the given app.

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()) {
   ListEvaluationDatasetsRequest request =
       ListEvaluationDatasetsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EvaluationDataset> future =
       evaluationServiceClient.listEvaluationDatasetsPagedCallable().futureCall(request);
   // Do something.
   for (EvaluationDataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationDatasetsRequest,ListEvaluationDatasetsPagedResponse>

listEvaluationExpectations(AppName parent)

public final EvaluationServiceClient.ListEvaluationExpectationsPagedResponse listEvaluationExpectations(AppName parent)

Lists all evaluation expectations in the given app.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   for (EvaluationExpectation element :
       evaluationServiceClient.listEvaluationExpectations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent AppName

Required. The resource name of the app to list evaluation expectations from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationExpectationsPagedResponse

listEvaluationExpectations(ListEvaluationExpectationsRequest request)

public final EvaluationServiceClient.ListEvaluationExpectationsPagedResponse listEvaluationExpectations(ListEvaluationExpectationsRequest request)

Lists all evaluation expectations in the given app.

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()) {
   ListEvaluationExpectationsRequest request =
       ListEvaluationExpectationsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EvaluationExpectation element :
       evaluationServiceClient.listEvaluationExpectations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEvaluationExpectationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListEvaluationExpectationsPagedResponse

listEvaluationExpectations(String parent)

public final EvaluationServiceClient.ListEvaluationExpectationsPagedResponse listEvaluationExpectations(String parent)

Lists all evaluation expectations in the given app.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   for (EvaluationExpectation element :
       evaluationServiceClient.listEvaluationExpectations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the app to list evaluation expectations from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationExpectationsPagedResponse

listEvaluationExpectationsCallable()

public final UnaryCallable<ListEvaluationExpectationsRequest,ListEvaluationExpectationsResponse> listEvaluationExpectationsCallable()

Lists all evaluation expectations in the given app.

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()) {
   ListEvaluationExpectationsRequest request =
       ListEvaluationExpectationsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEvaluationExpectationsResponse response =
         evaluationServiceClient.listEvaluationExpectationsCallable().call(request);
     for (EvaluationExpectation element : response.getEvaluationExpectationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationExpectationsRequest,ListEvaluationExpectationsResponse>

listEvaluationExpectationsPagedCallable()

public final UnaryCallable<ListEvaluationExpectationsRequest,EvaluationServiceClient.ListEvaluationExpectationsPagedResponse> listEvaluationExpectationsPagedCallable()

Lists all evaluation expectations in the given app.

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()) {
   ListEvaluationExpectationsRequest request =
       ListEvaluationExpectationsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EvaluationExpectation> future =
       evaluationServiceClient.listEvaluationExpectationsPagedCallable().futureCall(request);
   // Do something.
   for (EvaluationExpectation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationExpectationsRequest,ListEvaluationExpectationsPagedResponse>

listEvaluationResults(EvaluationName parent)

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(EvaluationName parent)

Lists all evaluation results for a given 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 parent = EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]");
   for (EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent EvaluationName

Required. The resource name of the evaluation to list evaluation results from. To filter by evaluation run, use - as the evaluation ID and specify the evaluation run ID in the filter. For example: projects/{project}/locations/{location}/apps/{app}/evaluations/-

Returns
Type Description
EvaluationServiceClient.ListEvaluationResultsPagedResponse

listEvaluationResults(ListEvaluationResultsRequest request)

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(ListEvaluationResultsRequest request)

Lists all evaluation results for a given 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()
           .setParent(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEvaluationResultsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListEvaluationResultsPagedResponse

listEvaluationResults(String parent)

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(String parent)

Lists all evaluation results for a given 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 parent =
       EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString();
   for (EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the evaluation to list evaluation results from. To filter by evaluation run, use - as the evaluation ID and specify the evaluation run ID in the filter. For example: projects/{project}/locations/{location}/apps/{app}/evaluations/-

Returns
Type Description
EvaluationServiceClient.ListEvaluationResultsPagedResponse

listEvaluationResultsCallable()

public final UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsResponse> listEvaluationResultsCallable()

Lists all evaluation results for a given 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()
           .setParent(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEvaluationResultsResponse response =
         evaluationServiceClient.listEvaluationResultsCallable().call(request);
     for (EvaluationResult element : response.getEvaluationResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsResponse>

listEvaluationResultsPagedCallable()

public final UnaryCallable<ListEvaluationResultsRequest,EvaluationServiceClient.ListEvaluationResultsPagedResponse> listEvaluationResultsPagedCallable()

Lists all evaluation results for a given 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()
           .setParent(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EvaluationResult> future =
       evaluationServiceClient.listEvaluationResultsPagedCallable().futureCall(request);
   // Do something.
   for (EvaluationResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsPagedResponse>

listEvaluationRuns(AppName parent)

public final EvaluationServiceClient.ListEvaluationRunsPagedResponse listEvaluationRuns(AppName parent)

Lists all evaluation runs in the given app.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   for (EvaluationRun element :
       evaluationServiceClient.listEvaluationRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent AppName

Required. The resource name of the app to list evaluation runs from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationRunsPagedResponse

listEvaluationRuns(ListEvaluationRunsRequest request)

public final EvaluationServiceClient.ListEvaluationRunsPagedResponse listEvaluationRuns(ListEvaluationRunsRequest request)

Lists all evaluation runs in the given app.

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()) {
   ListEvaluationRunsRequest request =
       ListEvaluationRunsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (EvaluationRun element :
       evaluationServiceClient.listEvaluationRuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEvaluationRunsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListEvaluationRunsPagedResponse

listEvaluationRuns(String parent)

public final EvaluationServiceClient.ListEvaluationRunsPagedResponse listEvaluationRuns(String parent)

Lists all evaluation runs in the given app.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   for (EvaluationRun element :
       evaluationServiceClient.listEvaluationRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the app to list evaluation runs from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationRunsPagedResponse

listEvaluationRunsCallable()

public final UnaryCallable<ListEvaluationRunsRequest,ListEvaluationRunsResponse> listEvaluationRunsCallable()

Lists all evaluation runs in the given app.

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()) {
   ListEvaluationRunsRequest request =
       ListEvaluationRunsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListEvaluationRunsResponse response =
         evaluationServiceClient.listEvaluationRunsCallable().call(request);
     for (EvaluationRun element : response.getEvaluationRunsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationRunsRequest,ListEvaluationRunsResponse>

listEvaluationRunsPagedCallable()

public final UnaryCallable<ListEvaluationRunsRequest,EvaluationServiceClient.ListEvaluationRunsPagedResponse> listEvaluationRunsPagedCallable()

Lists all evaluation runs in the given app.

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()) {
   ListEvaluationRunsRequest request =
       ListEvaluationRunsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<EvaluationRun> future =
       evaluationServiceClient.listEvaluationRunsPagedCallable().futureCall(request);
   // Do something.
   for (EvaluationRun element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationRunsRequest,ListEvaluationRunsPagedResponse>

listEvaluations(AppName parent)

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(AppName parent)

Lists all evaluations in the given app.

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

Required. The resource name of the app to list evaluations from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationsPagedResponse

listEvaluations(ListEvaluationsRequest request)

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(ListEvaluationsRequest request)

Lists all evaluations in the given app.

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(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setEvaluationFilter("evaluationFilter1361994196")
           .setEvaluationRunFilter("evaluationRunFilter299014663")
           .setOrderBy("orderBy-1207110587")
           .setLastTenResults(true)
           .build();
   for (Evaluation element : evaluationServiceClient.listEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListEvaluationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListEvaluationsPagedResponse

listEvaluations(String parent)

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(String parent)

Lists all evaluations in the given app.

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

Required. The resource name of the app to list evaluations from.

Returns
Type Description
EvaluationServiceClient.ListEvaluationsPagedResponse

listEvaluationsCallable()

public final UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse> listEvaluationsCallable()

Lists all evaluations in the given app.

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(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setEvaluationFilter("evaluationFilter1361994196")
           .setEvaluationRunFilter("evaluationRunFilter299014663")
           .setOrderBy("orderBy-1207110587")
           .setLastTenResults(true)
           .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;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse>

listEvaluationsPagedCallable()

public final UnaryCallable<ListEvaluationsRequest,EvaluationServiceClient.ListEvaluationsPagedResponse> listEvaluationsPagedCallable()

Lists all evaluations in the given app.

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(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setEvaluationFilter("evaluationFilter1361994196")
           .setEvaluationRunFilter("evaluationRunFilter299014663")
           .setOrderBy("orderBy-1207110587")
           .setLastTenResults(true)
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.listEvaluationsPagedCallable().futureCall(request);
   // Do something.
   for (Evaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListEvaluationsRequest,ListEvaluationsPagedResponse>

listLocations(ListLocationsRequest request)

public final EvaluationServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.This method can be called in two ways:

* **List all public locations:** Use the path GET /v1/locations.* **List project-visible locations:** Use the pathGET /v1/projects/{project_id}/locations. This may include publiclocations as well as private or other locations specifically visibleto the project.

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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : evaluationServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.This method can be called in two ways:

* **List all public locations:** Use the path GET /v1/locations.* **List project-visible locations:** Use the pathGET /v1/projects/{project_id}/locations. This may include publiclocations as well as private or other locations specifically visibleto the project.

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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         evaluationServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,EvaluationServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.This method can be called in two ways:

* **List all public locations:** Use the path GET /v1/locations.* **List project-visible locations:** Use the pathGET /v1/projects/{project_id}/locations. This may include publiclocations as well as private or other locations specifically visibleto the project.

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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       evaluationServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listScheduledEvaluationRuns(AppName parent)

public final EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse listScheduledEvaluationRuns(AppName parent)

Lists all scheduled evaluation runs in the given app.

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()) {
   AppName parent = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   for (ScheduledEvaluationRun element :
       evaluationServiceClient.listScheduledEvaluationRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent AppName

Required. The resource name of the app to list scheduled evaluation runs from.

Returns
Type Description
EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse

listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request)

public final EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request)

Lists all scheduled evaluation runs in the given app.

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()) {
   ListScheduledEvaluationRunsRequest request =
       ListScheduledEvaluationRunsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ScheduledEvaluationRun element :
       evaluationServiceClient.listScheduledEvaluationRuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListScheduledEvaluationRunsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse

listScheduledEvaluationRuns(String parent)

public final EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse listScheduledEvaluationRuns(String parent)

Lists all scheduled evaluation runs in the given app.

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 = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   for (ScheduledEvaluationRun element :
       evaluationServiceClient.listScheduledEvaluationRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the app to list scheduled evaluation runs from.

Returns
Type Description
EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse

listScheduledEvaluationRunsCallable()

public final UnaryCallable<ListScheduledEvaluationRunsRequest,ListScheduledEvaluationRunsResponse> listScheduledEvaluationRunsCallable()

Lists all scheduled evaluation runs in the given app.

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()) {
   ListScheduledEvaluationRunsRequest request =
       ListScheduledEvaluationRunsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListScheduledEvaluationRunsResponse response =
         evaluationServiceClient.listScheduledEvaluationRunsCallable().call(request);
     for (ScheduledEvaluationRun element : response.getScheduledEvaluationRunsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListScheduledEvaluationRunsRequest,ListScheduledEvaluationRunsResponse>

listScheduledEvaluationRunsPagedCallable()

public final UnaryCallable<ListScheduledEvaluationRunsRequest,EvaluationServiceClient.ListScheduledEvaluationRunsPagedResponse> listScheduledEvaluationRunsPagedCallable()

Lists all scheduled evaluation runs in the given app.

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()) {
   ListScheduledEvaluationRunsRequest request =
       ListScheduledEvaluationRunsRequest.newBuilder()
           .setParent(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ScheduledEvaluationRun> future =
       evaluationServiceClient.listScheduledEvaluationRunsPagedCallable().futureCall(request);
   // Do something.
   for (ScheduledEvaluationRun element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListScheduledEvaluationRunsRequest,ListScheduledEvaluationRunsPagedResponse>

runEvaluationAsync(AppName app)

public final OperationFuture<RunEvaluationResponse,RunEvaluationOperationMetadata> runEvaluationAsync(AppName app)

Runs an evaluation of the app.

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()) {
   AppName app = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   RunEvaluationResponse response = evaluationServiceClient.runEvaluationAsync(app).get();
 }
 
Parameter
Name Description
app AppName

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
OperationFuture<RunEvaluationResponse,RunEvaluationOperationMetadata>

runEvaluationAsync(RunEvaluationRequest request)

public final OperationFuture<RunEvaluationResponse,RunEvaluationOperationMetadata> runEvaluationAsync(RunEvaluationRequest request)

Runs an evaluation of the app.

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()) {
   RunEvaluationRequest request =
       RunEvaluationRequest.newBuilder()
           .setApp(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .addAllEvaluations(new ArrayList<String>())
           .setEvaluationDataset(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .setDisplayName("displayName1714148973")
           .setAppVersion(
               AppVersionName.of("[PROJECT]", "[LOCATION]", "[APP]", "[VERSION]").toString())
           .setConfig(EvaluationConfig.newBuilder().build())
           .setRunCount(-485221797)
           .addAllPersonaRunConfigs(new ArrayList<PersonaRunConfig>())
           .setOptimizationConfig(OptimizationConfig.newBuilder().build())
           .setScheduledEvaluationRun(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .setGoldenRunMethod(GoldenRunMethod.forNumber(0))
           .setGenerateLatencyReport(true)
           .build();
   RunEvaluationResponse response = evaluationServiceClient.runEvaluationAsync(request).get();
 }
 
Parameter
Name Description
request RunEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
OperationFuture<RunEvaluationResponse,RunEvaluationOperationMetadata>

runEvaluationAsync(String app)

public final OperationFuture<RunEvaluationResponse,RunEvaluationOperationMetadata> runEvaluationAsync(String app)

Runs an evaluation of the app.

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 app = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   RunEvaluationResponse response = evaluationServiceClient.runEvaluationAsync(app).get();
 }
 
Parameter
Name Description
app String

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
OperationFuture<RunEvaluationResponse,RunEvaluationOperationMetadata>

runEvaluationCallable()

public final UnaryCallable<RunEvaluationRequest,Operation> runEvaluationCallable()

Runs an evaluation of the app.

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()) {
   RunEvaluationRequest request =
       RunEvaluationRequest.newBuilder()
           .setApp(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .addAllEvaluations(new ArrayList<String>())
           .setEvaluationDataset(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .setDisplayName("displayName1714148973")
           .setAppVersion(
               AppVersionName.of("[PROJECT]", "[LOCATION]", "[APP]", "[VERSION]").toString())
           .setConfig(EvaluationConfig.newBuilder().build())
           .setRunCount(-485221797)
           .addAllPersonaRunConfigs(new ArrayList<PersonaRunConfig>())
           .setOptimizationConfig(OptimizationConfig.newBuilder().build())
           .setScheduledEvaluationRun(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .setGoldenRunMethod(GoldenRunMethod.forNumber(0))
           .setGenerateLatencyReport(true)
           .build();
   ApiFuture<Operation> future =
       evaluationServiceClient.runEvaluationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<RunEvaluationRequest,Operation>

runEvaluationOperationCallable()

public final OperationCallable<RunEvaluationRequest,RunEvaluationResponse,RunEvaluationOperationMetadata> runEvaluationOperationCallable()

Runs an evaluation of the app.

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()) {
   RunEvaluationRequest request =
       RunEvaluationRequest.newBuilder()
           .setApp(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .addAllEvaluations(new ArrayList<String>())
           .setEvaluationDataset(
               EvaluationDatasetName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION_DATASET]")
                   .toString())
           .setDisplayName("displayName1714148973")
           .setAppVersion(
               AppVersionName.of("[PROJECT]", "[LOCATION]", "[APP]", "[VERSION]").toString())
           .setConfig(EvaluationConfig.newBuilder().build())
           .setRunCount(-485221797)
           .addAllPersonaRunConfigs(new ArrayList<PersonaRunConfig>())
           .setOptimizationConfig(OptimizationConfig.newBuilder().build())
           .setScheduledEvaluationRun(
               ScheduledEvaluationRunName.of(
                       "[PROJECT]", "[LOCATION]", "[APP]", "[SCHEDULED_EVALUATION_RUN]")
                   .toString())
           .setGoldenRunMethod(GoldenRunMethod.forNumber(0))
           .setGenerateLatencyReport(true)
           .build();
   OperationFuture<RunEvaluationResponse, RunEvaluationOperationMetadata> future =
       evaluationServiceClient.runEvaluationOperationCallable().futureCall(request);
   // Do something.
   RunEvaluationResponse response = future.get();
 }
 
Returns
Type Description
OperationCallable<RunEvaluationRequest,RunEvaluationResponse,RunEvaluationOperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testPersonaVoice(AppName app)

public final TestPersonaVoiceResponse testPersonaVoice(AppName app)

Tests the voice of a persona. Also accepts a default persona.

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()) {
   AppName app = AppName.of("[PROJECT]", "[LOCATION]", "[APP]");
   TestPersonaVoiceResponse response = evaluationServiceClient.testPersonaVoice(app);
 }
 
Parameter
Name Description
app AppName

Required. the resource name of the app to test the persona voice for. Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
TestPersonaVoiceResponse

testPersonaVoice(TestPersonaVoiceRequest request)

public final TestPersonaVoiceResponse testPersonaVoice(TestPersonaVoiceRequest request)

Tests the voice of a persona. Also accepts a default persona.

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()) {
   TestPersonaVoiceRequest request =
       TestPersonaVoiceRequest.newBuilder()
           .setApp(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPersonaId("personaId853188071")
           .setText("text3556653")
           .build();
   TestPersonaVoiceResponse response = evaluationServiceClient.testPersonaVoice(request);
 }
 
Parameter
Name Description
request TestPersonaVoiceRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
TestPersonaVoiceResponse

testPersonaVoice(String app)

public final TestPersonaVoiceResponse testPersonaVoice(String app)

Tests the voice of a persona. Also accepts a default persona.

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 app = AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString();
   TestPersonaVoiceResponse response = evaluationServiceClient.testPersonaVoice(app);
 }
 
Parameter
Name Description
app String

Required. the resource name of the app to test the persona voice for. Format: projects/{project}/locations/{location}/apps/{app}

Returns
Type Description
TestPersonaVoiceResponse

testPersonaVoiceCallable()

public final UnaryCallable<TestPersonaVoiceRequest,TestPersonaVoiceResponse> testPersonaVoiceCallable()

Tests the voice of a persona. Also accepts a default persona.

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()) {
   TestPersonaVoiceRequest request =
       TestPersonaVoiceRequest.newBuilder()
           .setApp(AppName.of("[PROJECT]", "[LOCATION]", "[APP]").toString())
           .setPersonaId("personaId853188071")
           .setText("text3556653")
           .build();
   ApiFuture<TestPersonaVoiceResponse> future =
       evaluationServiceClient.testPersonaVoiceCallable().futureCall(request);
   // Do something.
   TestPersonaVoiceResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<TestPersonaVoiceRequest,TestPersonaVoiceResponse>

updateEvaluation(Evaluation evaluation, FieldMask updateMask)

public final Evaluation updateEvaluation(Evaluation evaluation, FieldMask updateMask)

Updates an 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()) {
   Evaluation evaluation = Evaluation.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Evaluation response = evaluationServiceClient.updateEvaluation(evaluation, updateMask);
 }
 
Parameters
Name Description
evaluation Evaluation

Required. The evaluation to update.

updateMask FieldMask

Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Returns
Type Description
Evaluation

updateEvaluation(UpdateEvaluationRequest request)

public final Evaluation updateEvaluation(UpdateEvaluationRequest request)

Updates an 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()) {
   UpdateEvaluationRequest request =
       UpdateEvaluationRequest.newBuilder()
           .setEvaluation(Evaluation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Evaluation response = evaluationServiceClient.updateEvaluation(request);
 }
 
Parameter
Name Description
request UpdateEvaluationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Evaluation

updateEvaluationCallable()

public final UnaryCallable<UpdateEvaluationRequest,Evaluation> updateEvaluationCallable()

Updates an 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()) {
   UpdateEvaluationRequest request =
       UpdateEvaluationRequest.newBuilder()
           .setEvaluation(Evaluation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.updateEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEvaluationRequest,Evaluation>

updateEvaluationDataset(EvaluationDataset evaluationDataset, FieldMask updateMask)

public final EvaluationDataset updateEvaluationDataset(EvaluationDataset evaluationDataset, FieldMask updateMask)

Updates an evaluation dataset.

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()) {
   EvaluationDataset evaluationDataset = EvaluationDataset.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EvaluationDataset response =
       evaluationServiceClient.updateEvaluationDataset(evaluationDataset, updateMask);
 }
 
Parameters
Name Description
evaluationDataset EvaluationDataset

Required. The evaluation dataset to update.

updateMask FieldMask

Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Returns
Type Description
EvaluationDataset

updateEvaluationDataset(UpdateEvaluationDatasetRequest request)

public final EvaluationDataset updateEvaluationDataset(UpdateEvaluationDatasetRequest request)

Updates an evaluation dataset.

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()) {
   UpdateEvaluationDatasetRequest request =
       UpdateEvaluationDatasetRequest.newBuilder()
           .setEvaluationDataset(EvaluationDataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EvaluationDataset response = evaluationServiceClient.updateEvaluationDataset(request);
 }
 
Parameter
Name Description
request UpdateEvaluationDatasetRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationDataset

updateEvaluationDatasetCallable()

public final UnaryCallable<UpdateEvaluationDatasetRequest,EvaluationDataset> updateEvaluationDatasetCallable()

Updates an evaluation dataset.

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()) {
   UpdateEvaluationDatasetRequest request =
       UpdateEvaluationDatasetRequest.newBuilder()
           .setEvaluationDataset(EvaluationDataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EvaluationDataset> future =
       evaluationServiceClient.updateEvaluationDatasetCallable().futureCall(request);
   // Do something.
   EvaluationDataset response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEvaluationDatasetRequest,EvaluationDataset>

updateEvaluationExpectation(EvaluationExpectation evaluationExpectation, FieldMask updateMask)

public final EvaluationExpectation updateEvaluationExpectation(EvaluationExpectation evaluationExpectation, FieldMask updateMask)

Updates an evaluation expectation.

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()) {
   EvaluationExpectation evaluationExpectation = EvaluationExpectation.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EvaluationExpectation response =
       evaluationServiceClient.updateEvaluationExpectation(evaluationExpectation, updateMask);
 }
 
Parameters
Name Description
evaluationExpectation EvaluationExpectation

Required. The evaluation expectation to update.

updateMask FieldMask

Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Returns
Type Description
EvaluationExpectation

updateEvaluationExpectation(UpdateEvaluationExpectationRequest request)

public final EvaluationExpectation updateEvaluationExpectation(UpdateEvaluationExpectationRequest request)

Updates an evaluation expectation.

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()) {
   UpdateEvaluationExpectationRequest request =
       UpdateEvaluationExpectationRequest.newBuilder()
           .setEvaluationExpectation(EvaluationExpectation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EvaluationExpectation response = evaluationServiceClient.updateEvaluationExpectation(request);
 }
 
Parameter
Name Description
request UpdateEvaluationExpectationRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
EvaluationExpectation

updateEvaluationExpectationCallable()

public final UnaryCallable<UpdateEvaluationExpectationRequest,EvaluationExpectation> updateEvaluationExpectationCallable()

Updates an evaluation expectation.

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()) {
   UpdateEvaluationExpectationRequest request =
       UpdateEvaluationExpectationRequest.newBuilder()
           .setEvaluationExpectation(EvaluationExpectation.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EvaluationExpectation> future =
       evaluationServiceClient.updateEvaluationExpectationCallable().futureCall(request);
   // Do something.
   EvaluationExpectation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateEvaluationExpectationRequest,EvaluationExpectation>

updateScheduledEvaluationRun(ScheduledEvaluationRun scheduledEvaluationRun, FieldMask updateMask)

public final ScheduledEvaluationRun updateScheduledEvaluationRun(ScheduledEvaluationRun scheduledEvaluationRun, FieldMask updateMask)

Updates a scheduled evaluation run.

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()) {
   ScheduledEvaluationRun scheduledEvaluationRun = ScheduledEvaluationRun.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ScheduledEvaluationRun response =
       evaluationServiceClient.updateScheduledEvaluationRun(scheduledEvaluationRun, updateMask);
 }
 
Parameters
Name Description
scheduledEvaluationRun ScheduledEvaluationRun

Required. The scheduled evaluation run to update.

updateMask FieldMask

Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.

Returns
Type Description
ScheduledEvaluationRun

updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request)

public final ScheduledEvaluationRun updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request)

Updates a scheduled evaluation run.

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()) {
   UpdateScheduledEvaluationRunRequest request =
       UpdateScheduledEvaluationRunRequest.newBuilder()
           .setScheduledEvaluationRun(ScheduledEvaluationRun.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ScheduledEvaluationRun response =
       evaluationServiceClient.updateScheduledEvaluationRun(request);
 }
 
Parameter
Name Description
request UpdateScheduledEvaluationRunRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ScheduledEvaluationRun

updateScheduledEvaluationRunCallable()

public final UnaryCallable<UpdateScheduledEvaluationRunRequest,ScheduledEvaluationRun> updateScheduledEvaluationRunCallable()

Updates a scheduled evaluation run.

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()) {
   UpdateScheduledEvaluationRunRequest request =
       UpdateScheduledEvaluationRunRequest.newBuilder()
           .setScheduledEvaluationRun(ScheduledEvaluationRun.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ScheduledEvaluationRun> future =
       evaluationServiceClient.updateScheduledEvaluationRunCallable().futureCall(request);
   // Do something.
   ScheduledEvaluationRun response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateScheduledEvaluationRunRequest,ScheduledEvaluationRun>

uploadEvaluationAudio(EvaluationName name, ByteString audioContent)

public final UploadEvaluationAudioResponse uploadEvaluationAudio(EvaluationName name, ByteString audioContent)

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

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]", "[APP]", "[EVALUATION]");
   ByteString audioContent = ByteString.EMPTY;
   UploadEvaluationAudioResponse response =
       evaluationServiceClient.uploadEvaluationAudio(name, audioContent);
 }
 
Parameters
Name Description
name EvaluationName

Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

audioContent ByteString

Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).

Returns
Type Description
UploadEvaluationAudioResponse

uploadEvaluationAudio(UploadEvaluationAudioRequest request)

public final UploadEvaluationAudioResponse uploadEvaluationAudio(UploadEvaluationAudioRequest request)

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

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()) {
   UploadEvaluationAudioRequest request =
       UploadEvaluationAudioRequest.newBuilder()
           .setName(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setAudioContent(ByteString.EMPTY)
           .setPreviousAudioGcsUri("previousAudioGcsUri-117973292")
           .build();
   UploadEvaluationAudioResponse response =
       evaluationServiceClient.uploadEvaluationAudio(request);
 }
 
Parameter
Name Description
request UploadEvaluationAudioRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
UploadEvaluationAudioResponse

uploadEvaluationAudio(String name, ByteString audioContent)

public final UploadEvaluationAudioResponse uploadEvaluationAudio(String name, ByteString audioContent)

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

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]", "[APP]", "[EVALUATION]").toString();
   ByteString audioContent = ByteString.EMPTY;
   UploadEvaluationAudioResponse response =
       evaluationServiceClient.uploadEvaluationAudio(name, audioContent);
 }
 
Parameters
Name Description
name String

Required. The resource name of the Evaluation for which to upload the evaluation audio. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

audioContent ByteString

Required. The raw audio bytes. The format of the audio must be single-channel LINEAR16 with a sample rate of 16kHz (default InputAudioConfig).

Returns
Type Description
UploadEvaluationAudioResponse

uploadEvaluationAudioCallable()

public final UnaryCallable<UploadEvaluationAudioRequest,UploadEvaluationAudioResponse> uploadEvaluationAudioCallable()

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

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()) {
   UploadEvaluationAudioRequest request =
       UploadEvaluationAudioRequest.newBuilder()
           .setName(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[APP]", "[EVALUATION]").toString())
           .setAudioContent(ByteString.EMPTY)
           .setPreviousAudioGcsUri("previousAudioGcsUri-117973292")
           .build();
   ApiFuture<UploadEvaluationAudioResponse> future =
       evaluationServiceClient.uploadEvaluationAudioCallable().futureCall(request);
   // Do something.
   UploadEvaluationAudioResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UploadEvaluationAudioRequest,UploadEvaluationAudioResponse>