Class EvaluationServiceClient (0.47.0)

GitHub RepositoryProduct Reference

Service Description: Service for managing Evaluations,

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   EvaluationName name = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]");
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }

Note: close() needs to be called on the EvaluationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

GetEvaluation

Gets a Evaluation.

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

  • getEvaluation(GetEvaluationRequest request)

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

  • getEvaluation(EvaluationName name)

  • getEvaluation(String name)

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

  • getEvaluationCallable()

ListEvaluations

Gets a list of Evaluations.

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

  • listEvaluations(ListEvaluationsRequest request)

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

  • listEvaluations(LocationName parent)

  • listEvaluations(String parent)

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

  • listEvaluationsPagedCallable()

  • listEvaluationsCallable()

CreateEvaluation

Creates a Evaluation.

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

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

  • createEvaluationAsync(CreateEvaluationRequest request)

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

  • createEvaluationAsync(LocationName parent, Evaluation evaluation)

  • createEvaluationAsync(String parent, Evaluation evaluation)

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

  • createEvaluationOperationCallable()

  • createEvaluationCallable()

ListEvaluationResults

Gets a list of results for a given a Evaluation.

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

  • listEvaluationResults(ListEvaluationResultsRequest request)

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

  • listEvaluationResults(EvaluationName evaluation)

  • listEvaluationResults(String evaluation)

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

  • listEvaluationResultsPagedCallable()

  • listEvaluationResultsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of EvaluationServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EvaluationServiceSettings evaluationServiceSettings =
     EvaluationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EvaluationServiceClient evaluationServiceClient =
     EvaluationServiceClient.create(evaluationServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EvaluationServiceSettings evaluationServiceSettings =
     EvaluationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EvaluationServiceClient evaluationServiceClient =
     EvaluationServiceClient.create(evaluationServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EvaluationServiceSettings evaluationServiceSettings =
     EvaluationServiceSettings.newHttpJsonBuilder().build();
 EvaluationServiceClient evaluationServiceClient =
     EvaluationServiceClient.create(evaluationServiceSettings);

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

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

createEvaluationAsync(CreateEvaluationRequest request)

public final OperationFuture<Evaluation,CreateEvaluationMetadata> createEvaluationAsync(CreateEvaluationRequest request)

Creates a Evaluation.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   Evaluation response = evaluationServiceClient.createEvaluationAsync(request).get();
 }
Parameter
Name Description
request CreateEvaluationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Evaluation,CreateEvaluationMetadata>

createEvaluationAsync(LocationName parent, Evaluation evaluation)

public final OperationFuture<Evaluation,CreateEvaluationMetadata> createEvaluationAsync(LocationName parent, Evaluation evaluation)

Creates a Evaluation.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Evaluation evaluation = Evaluation.newBuilder().build();
   Evaluation response = evaluationServiceClient.createEvaluationAsync(parent, evaluation).get();
 }
Parameters
Name Description
parent LocationName

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

Required. The Evaluation to create.
Returns
Type Description
OperationFuture<Evaluation,CreateEvaluationMetadata>

createEvaluationAsync(String parent, Evaluation evaluation)

public final OperationFuture<Evaluation,CreateEvaluationMetadata> createEvaluationAsync(String parent, Evaluation evaluation)

Creates a Evaluation.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Evaluation evaluation = Evaluation.newBuilder().build();
   Evaluation response = evaluationServiceClient.createEvaluationAsync(parent, evaluation).get();
 }
Parameters
Name Description
parent String

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

Required. The Evaluation to create.
Returns
Type Description
OperationFuture<Evaluation,CreateEvaluationMetadata>

createEvaluationCallable()

public final UnaryCallable<CreateEvaluationRequest,Operation> createEvaluationCallable()

Creates a Evaluation.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       evaluationServiceClient.createEvaluationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEvaluationRequest,Operation>

createEvaluationOperationCallable()

public final OperationCallable<CreateEvaluationRequest,Evaluation,CreateEvaluationMetadata> createEvaluationOperationCallable()

Creates a Evaluation.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   CreateEvaluationRequest request =
       CreateEvaluationRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setEvaluation(Evaluation.newBuilder().build())
           .build();
   OperationFuture<Evaluation, CreateEvaluationMetadata> future =
       evaluationServiceClient.createEvaluationOperationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
Returns
Type Description
OperationCallable<CreateEvaluationRequest,Evaluation,CreateEvaluationMetadata>

getEvaluation(EvaluationName name)

public final Evaluation getEvaluation(EvaluationName name)

Gets a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   EvaluationName name = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]");
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
Parameter
Name Description
name EvaluationName

Required. Full resource name of Evaluation, such as projects/{project}/locations/{location}/evaluations/{evaluation}.

If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Evaluation does not exist, a NOT_FOUND error is returned.
Returns
Type Description
Evaluation

getEvaluation(GetEvaluationRequest request)

public final Evaluation getEvaluation(GetEvaluationRequest request)

Gets a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .build();
   Evaluation response = evaluationServiceClient.getEvaluation(request);
 }
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 a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String name = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString();
   Evaluation response = evaluationServiceClient.getEvaluation(name);
 }
Parameter
Name Description
name String

Required. Full resource name of Evaluation, such as projects/{project}/locations/{location}/evaluations/{evaluation}.

If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Evaluation does not exist, a NOT_FOUND error is returned.
Returns
Type Description
Evaluation

getEvaluationCallable()

public final UnaryCallable<GetEvaluationRequest,Evaluation> getEvaluationCallable()

Gets a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.getEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEvaluationRequest,Evaluation>

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

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

getSettings()

public final EvaluationServiceSettings getSettings()
Returns
Type Description
EvaluationServiceSettings

getStub()

public EvaluationServiceStub getStub()
Returns
Type Description
EvaluationServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listEvaluationResults(EvaluationName evaluation)

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(EvaluationName evaluation)

Gets a list of results for a given a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   EvaluationName evaluation = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]");
   for (ListEvaluationResultsResponse.EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(evaluation).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
evaluation EvaluationName

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

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

listEvaluationResults(ListEvaluationResultsRequest request)

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(ListEvaluationResultsRequest request)

Gets a list of results for a given a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationResultsRequest request =
       ListEvaluationResultsRequest.newBuilder()
           .setEvaluation(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ListEvaluationResultsResponse.EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEvaluationResultsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EvaluationServiceClient.ListEvaluationResultsPagedResponse

listEvaluationResults(String evaluation)

public final EvaluationServiceClient.ListEvaluationResultsPagedResponse listEvaluationResults(String evaluation)

Gets a list of results for a given a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String evaluation = EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString();
   for (ListEvaluationResultsResponse.EvaluationResult element :
       evaluationServiceClient.listEvaluationResults(evaluation).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
evaluation String

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

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

listEvaluationResultsCallable()

public final UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsResponse> listEvaluationResultsCallable()

Gets a list of results for a given a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationResultsRequest request =
       ListEvaluationResultsRequest.newBuilder()
           .setEvaluation(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEvaluationResultsResponse response =
         evaluationServiceClient.listEvaluationResultsCallable().call(request);
     for (ListEvaluationResultsResponse.EvaluationResult element :
         response.getEvaluationResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsResponse>

listEvaluationResultsPagedCallable()

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

Gets a list of results for a given a Evaluation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationResultsRequest request =
       ListEvaluationResultsRequest.newBuilder()
           .setEvaluation(
               EvaluationName.of("[PROJECT]", "[LOCATION]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ListEvaluationResultsResponse.EvaluationResult> future =
       evaluationServiceClient.listEvaluationResultsPagedCallable().futureCall(request);
   // Do something.
   for (ListEvaluationResultsResponse.EvaluationResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEvaluationResultsRequest,ListEvaluationResultsPagedResponse>

listEvaluations(ListEvaluationsRequest request)

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(ListEvaluationsRequest request)

Gets a list of Evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Evaluation element : evaluationServiceClient.listEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEvaluationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EvaluationServiceClient.ListEvaluationsPagedResponse

listEvaluations(LocationName parent)

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(LocationName parent)

Gets a list of Evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Evaluation element : evaluationServiceClient.listEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

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

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
Returns
Type Description
EvaluationServiceClient.ListEvaluationsPagedResponse

listEvaluations(String parent)

public final EvaluationServiceClient.ListEvaluationsPagedResponse listEvaluations(String parent)

Gets a list of Evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Evaluation element : evaluationServiceClient.listEvaluations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

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

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
Returns
Type Description
EvaluationServiceClient.ListEvaluationsPagedResponse

listEvaluationsCallable()

public final UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse> listEvaluationsCallable()

Gets a list of Evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEvaluationsResponse response =
         evaluationServiceClient.listEvaluationsCallable().call(request);
     for (Evaluation element : response.getEvaluationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEvaluationsRequest,ListEvaluationsResponse>

listEvaluationsPagedCallable()

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

Gets a list of Evaluations.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EvaluationServiceClient evaluationServiceClient = EvaluationServiceClient.create()) {
   ListEvaluationsRequest request =
       ListEvaluationsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Evaluation> future =
       evaluationServiceClient.listEvaluationsPagedCallable().futureCall(request);
   // Do something.
   for (Evaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEvaluationsRequest,ListEvaluationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()