3.96.0 (latest) 3.95.0 3.94.0 3.92.0 3.89.0 3.88.0 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

> [!WARNING]
> **Beta**
>
>
> This library is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1)
> of the Terms of Service. Pre-GA libraries might have limited support,
> and changes to pre-GA libraries might not be compatible with other pre-GA versions.
> For more information, see the
> [launch stage descriptions](https://docs.cloud.google.com/products#product-launch-stages).

|---|---|---|---|
| [GitHub Repository](https://github.com/googleapis/google-cloud-java/tree/main/java-aiplatform/google-cloud-aiplatform/src/main/java/com/google/cloud/aiplatform/v1beta1/OnlineEvaluatorServiceClient.java) | [Product Reference](https://cloud.google.com/vertex-ai/docs) | [REST Documentation](https://cloud.google.com/vertex-ai/docs/reference/rest) | [RPC Documentation](https://cloud.google.com/vertex-ai/docs/reference/rpc) |

Service Description: This service is used to create and manage Vertex AI OnlineEvaluators.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       OnlineEvaluatorName name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]");
       OnlineEvaluator response = onlineEvaluatorServiceClient.getOnlineEvaluator(name);
     }
     
Note: close() needs to be called on the OnlineEvaluatorServiceClient object to clean up
resources such as threads. In the example above, try-with-resources is used, which automatically
calls close().

| Method | Description | Method Variants |
|---|---|---|
| CreateOnlineEvaluator | Creates an OnlineEvaluator in the given project and location. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - createOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - createOnlineEvaluatorAsync(LocationName parent, OnlineEvaluator onlineEvaluator) - createOnlineEvaluatorAsync(String parent, OnlineEvaluator onlineEvaluator) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - createOnlineEvaluatorOperationCallable() - createOnlineEvaluatorCallable() |
| GetOnlineEvaluator | Gets details of an OnlineEvaluator. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getOnlineEvaluator(GetOnlineEvaluatorRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - getOnlineEvaluator(OnlineEvaluatorName name) - getOnlineEvaluator(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. - getOnlineEvaluatorCallable() |
| UpdateOnlineEvaluator | Updates the fields of an OnlineEvaluator. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - updateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - updateOnlineEvaluatorAsync(OnlineEvaluator onlineEvaluator, 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. - updateOnlineEvaluatorOperationCallable() - updateOnlineEvaluatorCallable() |
| DeleteOnlineEvaluator | Deletes an OnlineEvaluator. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - deleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - deleteOnlineEvaluatorAsync(OnlineEvaluatorName name) - deleteOnlineEvaluatorAsync(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. - deleteOnlineEvaluatorOperationCallable() - deleteOnlineEvaluatorCallable() |
| ListOnlineEvaluators | Lists the OnlineEvaluators for the given project and location. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - listOnlineEvaluators(ListOnlineEvaluatorsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - listOnlineEvaluators(LocationName parent) - listOnlineEvaluators(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. - listOnlineEvaluatorsPagedCallable() - listOnlineEvaluatorsCallable() |
| ActivateOnlineEvaluator | Activates an OnlineEvaluator. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - activateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - activateOnlineEvaluatorAsync(OnlineEvaluatorName name) - activateOnlineEvaluatorAsync(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. - activateOnlineEvaluatorOperationCallable() - activateOnlineEvaluatorCallable() |
| SuspendOnlineEvaluator | Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - suspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - suspendOnlineEvaluatorAsync(OnlineEvaluatorName name) - suspendOnlineEvaluatorAsync(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. - suspendOnlineEvaluatorOperationCallable() - suspendOnlineEvaluatorCallable() |
| ListLocations | Lists information about the supported locations for this service. | 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() |
| SetIamPolicy | Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - setIamPolicyCallable() |
| GetIamPolicy | Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - getIamPolicyCallable() |
| TestIamPermissions | Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - testIamPermissionsCallable() |
[Methods]

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 OnlineEvaluatorServiceSettings
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
     OnlineEvaluatorServiceSettings onlineEvaluatorServiceSettings =
         OnlineEvaluatorServiceSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create(onlineEvaluatorServiceSettings);
     
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
     OnlineEvaluatorServiceSettings onlineEvaluatorServiceSettings =
         OnlineEvaluatorServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
     OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create(onlineEvaluatorServiceSettings);
     
Please refer to the GitHub repository's samples for more quickstart code snippets.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> OnlineEvaluatorServiceClient

## Static Methods

### create()

    public static final OnlineEvaluatorServiceClient create()

Constructs an instance of OnlineEvaluatorServiceClient with default settings.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### create(OnlineEvaluatorServiceSettings settings)

    public static final OnlineEvaluatorServiceClient create(OnlineEvaluatorServiceSettings settings)

Constructs an instance of OnlineEvaluatorServiceClient, 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` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceSettings` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### create(OnlineEvaluatorServiceStub stub)

    public static final OnlineEvaluatorServiceClient create(OnlineEvaluatorServiceStub stub)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.stub.OnlineEvaluatorServiceStub` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient` |   |

## Constructors

### OnlineEvaluatorServiceClient(OnlineEvaluatorServiceSettings settings)

    protected OnlineEvaluatorServiceClient(OnlineEvaluatorServiceSettings settings)

Constructs an instance of OnlineEvaluatorServiceClient, 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` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceSettings` |

### OnlineEvaluatorServiceClient(OnlineEvaluatorServiceStub stub)

    protected OnlineEvaluatorServiceClient(OnlineEvaluatorServiceStub stub)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.stub.OnlineEvaluatorServiceStub` |

## Methods

### activateOnlineEvaluatorAsync(@Nullable OnlineEvaluatorName name)

    public final OperationFuture<OnlineEvaluator,ActivateOnlineEvaluatorOperationMetadata> activateOnlineEvaluatorAsync(@Nullable OnlineEvaluatorName name)

Activates an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       OnlineEvaluatorName name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]");
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.activateOnlineEvaluatorAsync(name).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorName` Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorOperationMetadata>` |   |

### activateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest request)

    public final OperationFuture<OnlineEvaluator,ActivateOnlineEvaluatorOperationMetadata> activateOnlineEvaluatorAsync(ActivateOnlineEvaluatorRequest request)

Activates an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ActivateOnlineEvaluatorRequest request =
           ActivateOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.activateOnlineEvaluatorAsync(request).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorOperationMetadata>` |   |

### activateOnlineEvaluatorAsync(String name)

    public final OperationFuture<OnlineEvaluator,ActivateOnlineEvaluatorOperationMetadata> activateOnlineEvaluatorAsync(String name)

Activates an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       String name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]").toString();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.activateOnlineEvaluatorAsync(name).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorOperationMetadata>` |   |

### activateOnlineEvaluatorCallable()

    public final UnaryCallable<ActivateOnlineEvaluatorRequest,Operation> activateOnlineEvaluatorCallable()

Activates an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ActivateOnlineEvaluatorRequest request =
           ActivateOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       ApiFuture<Operation> future =
           onlineEvaluatorServiceClient.activateOnlineEvaluatorCallable().futureCall(request);
       // Do something.
       Operation response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.longrunning.Operation.html>` |   |

### activateOnlineEvaluatorOperationCallable()

    public final OperationCallable<ActivateOnlineEvaluatorRequest,OnlineEvaluator,ActivateOnlineEvaluatorOperationMetadata> activateOnlineEvaluatorOperationCallable()

Activates an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ActivateOnlineEvaluatorRequest request =
           ActivateOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       OperationFuture<OnlineEvaluator, ActivateOnlineEvaluatorOperationMetadata> future =
           onlineEvaluatorServiceClient
               .activateOnlineEvaluatorOperationCallable()
               .futureCall(request);
       // Do something.
       OnlineEvaluator response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.OperationCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ActivateOnlineEvaluatorOperationMetadata>` |   |

### awaitTermination(long duration, TimeUnit unit)

    public boolean awaitTermination(long duration, TimeUnit unit)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `duration` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |
| `unit` | `https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html` |   |

### close()

    public final void close()

### createOnlineEvaluatorAsync(@Nullable LocationName parent, OnlineEvaluator onlineEvaluator)

    public final OperationFuture<OnlineEvaluator,CreateOnlineEvaluatorOperationMetadata> createOnlineEvaluatorAsync(@Nullable LocationName parent, OnlineEvaluator onlineEvaluator)

Creates an OnlineEvaluator in the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
       OnlineEvaluator onlineEvaluator = OnlineEvaluator.newBuilder().build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.createOnlineEvaluatorAsync(parent, onlineEvaluator).get();
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.LocationName` Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}. |
| `onlineEvaluator` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator` Required. The OnlineEvaluator to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorOperationMetadata>` |   |

### createOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest request)

    public final OperationFuture<OnlineEvaluator,CreateOnlineEvaluatorOperationMetadata> createOnlineEvaluatorAsync(CreateOnlineEvaluatorRequest request)

Creates an OnlineEvaluator in the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       CreateOnlineEvaluatorRequest request =
           CreateOnlineEvaluatorRequest.newBuilder()
               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
               .setOnlineEvaluator(OnlineEvaluator.newBuilder().build())
               .build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.createOnlineEvaluatorAsync(request).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorOperationMetadata>` |   |

### createOnlineEvaluatorAsync(String parent, OnlineEvaluator onlineEvaluator)

    public final OperationFuture<OnlineEvaluator,CreateOnlineEvaluatorOperationMetadata> createOnlineEvaluatorAsync(String parent, OnlineEvaluator onlineEvaluator)

Creates an OnlineEvaluator in the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
       OnlineEvaluator onlineEvaluator = OnlineEvaluator.newBuilder().build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.createOnlineEvaluatorAsync(parent, onlineEvaluator).get();
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}. |
| `onlineEvaluator` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator` Required. The OnlineEvaluator to create. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorOperationMetadata>` |   |

### createOnlineEvaluatorCallable()

    public final UnaryCallable<CreateOnlineEvaluatorRequest,Operation> createOnlineEvaluatorCallable()

Creates an OnlineEvaluator in the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       CreateOnlineEvaluatorRequest request =
           CreateOnlineEvaluatorRequest.newBuilder()
               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
               .setOnlineEvaluator(OnlineEvaluator.newBuilder().build())
               .build();
       ApiFuture<Operation> future =
           onlineEvaluatorServiceClient.createOnlineEvaluatorCallable().futureCall(request);
       // Do something.
       Operation response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.longrunning.Operation.html>` |   |

### createOnlineEvaluatorOperationCallable()

    public final OperationCallable<CreateOnlineEvaluatorRequest,OnlineEvaluator,CreateOnlineEvaluatorOperationMetadata> createOnlineEvaluatorOperationCallable()

Creates an OnlineEvaluator in the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       CreateOnlineEvaluatorRequest request =
           CreateOnlineEvaluatorRequest.newBuilder()
               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
               .setOnlineEvaluator(OnlineEvaluator.newBuilder().build())
               .build();
       OperationFuture<OnlineEvaluator, CreateOnlineEvaluatorOperationMetadata> future =
           onlineEvaluatorServiceClient.createOnlineEvaluatorOperationCallable().futureCall(request);
       // Do something.
       OnlineEvaluator response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.OperationCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.CreateOnlineEvaluatorOperationMetadata>` |   |

### deleteOnlineEvaluatorAsync(@Nullable OnlineEvaluatorName name)

    public final OperationFuture<Empty,DeleteOnlineEvaluatorOperationMetadata> deleteOnlineEvaluatorAsync(@Nullable OnlineEvaluatorName name)

Deletes an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       OnlineEvaluatorName name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]");
       onlineEvaluatorServiceClient.deleteOnlineEvaluatorAsync(name).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorName` Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorOperationMetadata>` |   |

### deleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest request)

    public final OperationFuture<Empty,DeleteOnlineEvaluatorOperationMetadata> deleteOnlineEvaluatorAsync(DeleteOnlineEvaluatorRequest request)

Deletes an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       DeleteOnlineEvaluatorRequest request =
           DeleteOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       onlineEvaluatorServiceClient.deleteOnlineEvaluatorAsync(request).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorOperationMetadata>` |   |

### deleteOnlineEvaluatorAsync(String name)

    public final OperationFuture<Empty,DeleteOnlineEvaluatorOperationMetadata> deleteOnlineEvaluatorAsync(String name)

Deletes an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       String name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]").toString();
       onlineEvaluatorServiceClient.deleteOnlineEvaluatorAsync(name).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorOperationMetadata>` |   |

### deleteOnlineEvaluatorCallable()

    public final UnaryCallable<DeleteOnlineEvaluatorRequest,Operation> deleteOnlineEvaluatorCallable()

Deletes an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       DeleteOnlineEvaluatorRequest request =
           DeleteOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       ApiFuture<Operation> future =
           onlineEvaluatorServiceClient.deleteOnlineEvaluatorCallable().futureCall(request);
       // Do something.
       future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.longrunning.Operation.html>` |   |

### deleteOnlineEvaluatorOperationCallable()

    public final OperationCallable<DeleteOnlineEvaluatorRequest,Empty,DeleteOnlineEvaluatorOperationMetadata> deleteOnlineEvaluatorOperationCallable()

Deletes an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       DeleteOnlineEvaluatorRequest request =
           DeleteOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       OperationFuture<Empty, DeleteOnlineEvaluatorOperationMetadata> future =
           onlineEvaluatorServiceClient.deleteOnlineEvaluatorOperationCallable().futureCall(request);
       // Do something.
       future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.OperationCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorRequest,https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Empty.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.DeleteOnlineEvaluatorOperationMetadata>` |   |

### getIamPolicy(GetIamPolicyRequest request)

    public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists
and does not have a policy set.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       GetIamPolicyRequest request =
           GetIamPolicyRequest.newBuilder()
               .setResource(
                   EndpointName.ofProjectLocationEndpointName(
                           "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                       .toString())
               .setOptions(GetPolicyOptions.newBuilder().build())
               .build();
       Policy response = onlineEvaluatorServiceClient.getIamPolicy(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### getIamPolicyCallable()

    public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists
and does not have a policy set.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       GetIamPolicyRequest request =
           GetIamPolicyRequest.newBuilder()
               .setResource(
                   EndpointName.ofProjectLocationEndpointName(
                           "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                       .toString())
               .setOptions(GetPolicyOptions.newBuilder().build())
               .build();
       ApiFuture<Policy> future =
           onlineEvaluatorServiceClient.getIamPolicyCallable().futureCall(request);
       // Do something.
       Policy response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>` |   |

### 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
       Location response = onlineEvaluatorServiceClient.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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
       ApiFuture<Location> future =
           onlineEvaluatorServiceClient.getLocationCallable().futureCall(request);
       // Do something.
       Location response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>` |   |

### getOnlineEvaluator(@Nullable OnlineEvaluatorName name)

    public final OnlineEvaluator getOnlineEvaluator(@Nullable OnlineEvaluatorName name)

Gets details of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       OnlineEvaluatorName name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]");
       OnlineEvaluator response = onlineEvaluatorServiceClient.getOnlineEvaluator(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorName` Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator` |   |

### getOnlineEvaluator(GetOnlineEvaluatorRequest request)

    public final OnlineEvaluator getOnlineEvaluator(GetOnlineEvaluatorRequest request)

Gets details of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       GetOnlineEvaluatorRequest request =
           GetOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       OnlineEvaluator response = onlineEvaluatorServiceClient.getOnlineEvaluator(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.GetOnlineEvaluatorRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator` |   |

### getOnlineEvaluator(String name)

    public final OnlineEvaluator getOnlineEvaluator(String name)

Gets details of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       String name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]").toString();
       OnlineEvaluator response = onlineEvaluatorServiceClient.getOnlineEvaluator(name);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator` |   |

### getOnlineEvaluatorCallable()

    public final UnaryCallable<GetOnlineEvaluatorRequest,OnlineEvaluator> getOnlineEvaluatorCallable()

Gets details of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       GetOnlineEvaluatorRequest request =
           GetOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       ApiFuture<OnlineEvaluator> future =
           onlineEvaluatorServiceClient.getOnlineEvaluatorCallable().futureCall(request);
       // Do something.
       OnlineEvaluator response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.GetOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator>` |   |

### 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** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.longrunning.OperationsClient.html` |   |

### getSettings()

    public final @Nullable OnlineEvaluatorServiceSettings getSettings()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceSettings` |   |

### getStub()

    public OnlineEvaluatorServiceStub getStub()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.stub.OnlineEvaluatorServiceStub` |   |

### isShutdown()

    public boolean isShutdown()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### isTerminated()

    public boolean isTerminated()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### listLocations(ListLocationsRequest request)

    public final OnlineEvaluatorServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ListLocationsRequest request =
           ListLocationsRequest.newBuilder()
               .setName("name3373707")
               .setFilter("filter-1274492040")
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .build();
       for (Location element : onlineEvaluatorServiceClient.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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient.ListLocationsPagedResponse` |   |

### listLocationsCallable()

    public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ListLocationsRequest request =
           ListLocationsRequest.newBuilder()
               .setName("name3373707")
               .setFilter("filter-1274492040")
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .build();
       while (true) {
         ListLocationsResponse response =
             onlineEvaluatorServiceClient.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** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>` |   |

### listLocationsPagedCallable()

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

Lists information about the supported locations for this service.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ListLocationsRequest request =
           ListLocationsRequest.newBuilder()
               .setName("name3373707")
               .setFilter("filter-1274492040")
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .build();
       ApiFuture<Location> future =
           onlineEvaluatorServiceClient.listLocationsPagedCallable().futureCall(request);
       // Do something.
       for (Location element : future.get().iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.cloud.location.ListLocationsRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient.ListLocationsPagedResponse>` |   |

### listOnlineEvaluators(@Nullable LocationName parent)

    public final OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse listOnlineEvaluators(@Nullable LocationName parent)

Lists the OnlineEvaluators for the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
       for (OnlineEvaluator element :
           onlineEvaluatorServiceClient.listOnlineEvaluators(parent).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.LocationName` Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse` |   |

### listOnlineEvaluators(ListOnlineEvaluatorsRequest request)

    public final OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse listOnlineEvaluators(ListOnlineEvaluatorsRequest request)

Lists the OnlineEvaluators for the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ListOnlineEvaluatorsRequest request =
           ListOnlineEvaluatorsRequest.newBuilder()
               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .setFilter("filter-1274492040")
               .setOrderBy("orderBy-1207110587")
               .build();
       for (OnlineEvaluator element :
           onlineEvaluatorServiceClient.listOnlineEvaluators(request).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ListOnlineEvaluatorsRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse` |   |

### listOnlineEvaluators(String parent)

    public final OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse listOnlineEvaluators(String parent)

Lists the OnlineEvaluators for the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
       for (OnlineEvaluator element :
           onlineEvaluatorServiceClient.listOnlineEvaluators(parent).iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse` |   |

### listOnlineEvaluatorsCallable()

    public final UnaryCallable<ListOnlineEvaluatorsRequest,ListOnlineEvaluatorsResponse> listOnlineEvaluatorsCallable()

Lists the OnlineEvaluators for the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ListOnlineEvaluatorsRequest request =
           ListOnlineEvaluatorsRequest.newBuilder()
               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .setFilter("filter-1274492040")
               .setOrderBy("orderBy-1207110587")
               .build();
       while (true) {
         ListOnlineEvaluatorsResponse response =
             onlineEvaluatorServiceClient.listOnlineEvaluatorsCallable().call(request);
         for (OnlineEvaluator element : response.getOnlineEvaluatorsList()) {
           // doThingsWith(element);
         }
         String nextPageToken = response.getNextPageToken();
         if (!Strings.isNullOrEmpty(nextPageToken)) {
           request = request.toBuilder().setPageToken(nextPageToken).build();
         } else {
           break;
         }
       }
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ListOnlineEvaluatorsRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ListOnlineEvaluatorsResponse>` |   |

### listOnlineEvaluatorsPagedCallable()

    public final UnaryCallable<ListOnlineEvaluatorsRequest,OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse> listOnlineEvaluatorsPagedCallable()

Lists the OnlineEvaluators for the given project and 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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       ListOnlineEvaluatorsRequest request =
           ListOnlineEvaluatorsRequest.newBuilder()
               .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
               .setPageSize(883849137)
               .setPageToken("pageToken873572522")
               .setFilter("filter-1274492040")
               .setOrderBy("orderBy-1207110587")
               .build();
       ApiFuture<OnlineEvaluator> future =
           onlineEvaluatorServiceClient.listOnlineEvaluatorsPagedCallable().futureCall(request);
       // Do something.
       for (OnlineEvaluator element : future.get().iterateAll()) {
         // doThingsWith(element);
       }
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.ListOnlineEvaluatorsRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorServiceClient.ListOnlineEvaluatorsPagedResponse>` |   |

### setIamPolicy(SetIamPolicyRequest request)

    public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       SetIamPolicyRequest request =
           SetIamPolicyRequest.newBuilder()
               .setResource(
                   EndpointName.ofProjectLocationEndpointName(
                           "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                       .toString())
               .setPolicy(Policy.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       Policy response = onlineEvaluatorServiceClient.setIamPolicy(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### setIamPolicyCallable()

    public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       SetIamPolicyRequest request =
           SetIamPolicyRequest.newBuilder()
               .setResource(
                   EndpointName.ofProjectLocationEndpointName(
                           "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                       .toString())
               .setPolicy(Policy.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       ApiFuture<Policy> future =
           onlineEvaluatorServiceClient.setIamPolicyCallable().futureCall(request);
       // Do something.
       Policy response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()

### suspendOnlineEvaluatorAsync(@Nullable OnlineEvaluatorName name)

    public final OperationFuture<OnlineEvaluator,SuspendOnlineEvaluatorOperationMetadata> suspendOnlineEvaluatorAsync(@Nullable OnlineEvaluatorName name)

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations
until it is activated again.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       OnlineEvaluatorName name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]");
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.suspendOnlineEvaluatorAsync(name).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `@org.jspecify.annotations.Nullable com.google.cloud.aiplatform.v1beta1.OnlineEvaluatorName` Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorOperationMetadata>` |   |

### suspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest request)

    public final OperationFuture<OnlineEvaluator,SuspendOnlineEvaluatorOperationMetadata> suspendOnlineEvaluatorAsync(SuspendOnlineEvaluatorRequest request)

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations
until it is activated again.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       SuspendOnlineEvaluatorRequest request =
           SuspendOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.suspendOnlineEvaluatorAsync(request).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorOperationMetadata>` |   |

### suspendOnlineEvaluatorAsync(String name)

    public final OperationFuture<OnlineEvaluator,SuspendOnlineEvaluatorOperationMetadata> suspendOnlineEvaluatorAsync(String name)

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations
until it is activated again.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       String name =
           OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]").toString();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.suspendOnlineEvaluatorAsync(name).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorOperationMetadata>` |   |

### suspendOnlineEvaluatorCallable()

    public final UnaryCallable<SuspendOnlineEvaluatorRequest,Operation> suspendOnlineEvaluatorCallable()

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations
until it is activated again.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       SuspendOnlineEvaluatorRequest request =
           SuspendOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       ApiFuture<Operation> future =
           onlineEvaluatorServiceClient.suspendOnlineEvaluatorCallable().futureCall(request);
       // Do something.
       Operation response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.longrunning.Operation.html>` |   |

### suspendOnlineEvaluatorOperationCallable()

    public final OperationCallable<SuspendOnlineEvaluatorRequest,OnlineEvaluator,SuspendOnlineEvaluatorOperationMetadata> suspendOnlineEvaluatorOperationCallable()

Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations
until it is activated again.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       SuspendOnlineEvaluatorRequest request =
           SuspendOnlineEvaluatorRequest.newBuilder()
               .setName(
                   OnlineEvaluatorName.of("[PROJECT]", "[LOCATION]", "[ONLINE_EVALUATOR]")
                       .toString())
               .build();
       OperationFuture<OnlineEvaluator, SuspendOnlineEvaluatorOperationMetadata> future =
           onlineEvaluatorServiceClient
               .suspendOnlineEvaluatorOperationCallable()
               .futureCall(request);
       // Do something.
       OnlineEvaluator response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.OperationCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.SuspendOnlineEvaluatorOperationMetadata>` |   |

### testIamPermissions(TestIamPermissionsRequest request)

    public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and
command-line tools, not for authorizationchecking. This operation may "fail open" without
warning.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       TestIamPermissionsRequest request =
           TestIamPermissionsRequest.newBuilder()
               .setResource(
                   EndpointName.ofProjectLocationEndpointName(
                           "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                       .toString())
               .addAllPermissions(new ArrayList<String>())
               .build();
       TestIamPermissionsResponse response =
           onlineEvaluatorServiceClient.testIamPermissions(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.TestIamPermissionsResponse` |   |

### testIamPermissionsCallable()

    public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and
command-line tools, not for authorizationchecking. This operation may "fail open" without
warning.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       TestIamPermissionsRequest request =
           TestIamPermissionsRequest.newBuilder()
               .setResource(
                   EndpointName.ofProjectLocationEndpointName(
                           "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                       .toString())
               .addAllPermissions(new ArrayList<String>())
               .build();
       ApiFuture<TestIamPermissionsResponse> future =
           onlineEvaluatorServiceClient.testIamPermissionsCallable().futureCall(request);
       // Do something.
       TestIamPermissionsResponse response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>` |   |

### updateOnlineEvaluatorAsync(OnlineEvaluator onlineEvaluator, FieldMask updateMask)

    public final OperationFuture<OnlineEvaluator,UpdateOnlineEvaluatorOperationMetadata> updateOnlineEvaluatorAsync(OnlineEvaluator onlineEvaluator, FieldMask updateMask)

Updates the fields of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       OnlineEvaluator onlineEvaluator = OnlineEvaluator.newBuilder().build();
       FieldMask updateMask = FieldMask.newBuilder().build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient
               .updateOnlineEvaluatorAsync(onlineEvaluator, updateMask)
               .get();
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `onlineEvaluator` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator` Required. The OnlineEvaluator to update. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}. |
| `updateMask` | `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask.html` 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** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.UpdateOnlineEvaluatorOperationMetadata>` |   |

### updateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest request)

    public final OperationFuture<OnlineEvaluator,UpdateOnlineEvaluatorOperationMetadata> updateOnlineEvaluatorAsync(UpdateOnlineEvaluatorRequest request)

Updates the fields of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       UpdateOnlineEvaluatorRequest request =
           UpdateOnlineEvaluatorRequest.newBuilder()
               .setOnlineEvaluator(OnlineEvaluator.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       OnlineEvaluator response =
           onlineEvaluatorServiceClient.updateOnlineEvaluatorAsync(request).get();
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.UpdateOnlineEvaluatorRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.longrunning.OperationFuture.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.UpdateOnlineEvaluatorOperationMetadata>` |   |

### updateOnlineEvaluatorCallable()

    public final UnaryCallable<UpdateOnlineEvaluatorRequest,Operation> updateOnlineEvaluatorCallable()

Updates the fields of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       UpdateOnlineEvaluatorRequest request =
           UpdateOnlineEvaluatorRequest.newBuilder()
               .setOnlineEvaluator(OnlineEvaluator.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       ApiFuture<Operation> future =
           onlineEvaluatorServiceClient.updateOnlineEvaluatorCallable().futureCall(request);
       // Do something.
       Operation response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.UpdateOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.longrunning.Operation.html>` |   |

### updateOnlineEvaluatorOperationCallable()

    public final OperationCallable<UpdateOnlineEvaluatorRequest,OnlineEvaluator,UpdateOnlineEvaluatorOperationMetadata> updateOnlineEvaluatorOperationCallable()

Updates the fields of an OnlineEvaluator.

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 (OnlineEvaluatorServiceClient onlineEvaluatorServiceClient =
         OnlineEvaluatorServiceClient.create()) {
       UpdateOnlineEvaluatorRequest request =
           UpdateOnlineEvaluatorRequest.newBuilder()
               .setOnlineEvaluator(OnlineEvaluator.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       OperationFuture<OnlineEvaluator, UpdateOnlineEvaluatorOperationMetadata> future =
           onlineEvaluatorServiceClient.updateOnlineEvaluatorOperationCallable().futureCall(request);
       // Do something.
       OnlineEvaluator response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.OperationCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.UpdateOnlineEvaluatorRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.OnlineEvaluator,https://docs.cloud.google.com/java/docs/reference/google-cloud-aiplatform/latest/com.google.cloud.aiplatform.v1beta1.UpdateOnlineEvaluatorOperationMetadata>` |   |