Class ModelMonitoringServiceClient (3.54.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: A service for creating and managing Vertex AI Model moitoring. This includes ModelMonitor resources, ModelMonitoringJob resources.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName name = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   ModelMonitor response = modelMonitoringServiceClient.getModelMonitor(name);
 }
 

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

Methods
Method Description Method Variants

CreateModelMonitor

Creates a ModelMonitor.

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

  • createModelMonitorAsync(CreateModelMonitorRequest request)

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

  • createModelMonitorAsync(LocationName parent, ModelMonitor modelMonitor)

  • createModelMonitorAsync(String parent, ModelMonitor modelMonitor)

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

  • createModelMonitorOperationCallable()

  • createModelMonitorCallable()

UpdateModelMonitor

Updates a ModelMonitor.

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

  • updateModelMonitorAsync(UpdateModelMonitorRequest request)

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

  • updateModelMonitorAsync(ModelMonitor modelMonitor, 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.

  • updateModelMonitorOperationCallable()

  • updateModelMonitorCallable()

GetModelMonitor

Gets a ModelMonitor.

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

  • getModelMonitor(GetModelMonitorRequest request)

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

  • getModelMonitor(ModelMonitorName name)

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

  • getModelMonitorCallable()

ListModelMonitors

Lists ModelMonitors in a Location.

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

  • listModelMonitors(ListModelMonitorsRequest request)

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

  • listModelMonitors(LocationName parent)

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

  • listModelMonitorsPagedCallable()

  • listModelMonitorsCallable()

DeleteModelMonitor

Deletes a ModelMonitor.

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

  • deleteModelMonitorAsync(DeleteModelMonitorRequest request)

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

  • deleteModelMonitorAsync(ModelMonitorName name)

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

  • deleteModelMonitorOperationCallable()

  • deleteModelMonitorCallable()

CreateModelMonitoringJob

Creates a ModelMonitoringJob.

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

  • createModelMonitoringJob(CreateModelMonitoringJobRequest request)

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

  • createModelMonitoringJob(ModelMonitorName parent, ModelMonitoringJob modelMonitoringJob)

  • createModelMonitoringJob(String parent, ModelMonitoringJob modelMonitoringJob)

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

  • createModelMonitoringJobCallable()

GetModelMonitoringJob

Gets a ModelMonitoringJob.

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

  • getModelMonitoringJob(GetModelMonitoringJobRequest request)

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

  • getModelMonitoringJob(ModelMonitoringJobName name)

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

  • getModelMonitoringJobCallable()

ListModelMonitoringJobs

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs

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

  • listModelMonitoringJobs(ListModelMonitoringJobsRequest request)

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

  • listModelMonitoringJobs(ModelMonitorName parent)

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

  • listModelMonitoringJobsPagedCallable()

  • listModelMonitoringJobsCallable()

DeleteModelMonitoringJob

Deletes a ModelMonitoringJob.

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

  • deleteModelMonitoringJobAsync(DeleteModelMonitoringJobRequest request)

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

  • deleteModelMonitoringJobAsync(ModelMonitoringJobName name)

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

  • deleteModelMonitoringJobOperationCallable()

  • deleteModelMonitoringJobCallable()

SearchModelMonitoringStats

Searches Model Monitoring Stats generated within a given time window.

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

  • searchModelMonitoringStats(SearchModelMonitoringStatsRequest request)

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

  • searchModelMonitoringStats(ModelMonitorName modelMonitor)

  • searchModelMonitoringStats(String modelMonitor)

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

  • searchModelMonitoringStatsPagedCallable()

  • searchModelMonitoringStatsCallable()

SearchModelMonitoringAlerts

Returns the Model Monitoring alerts.

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

  • searchModelMonitoringAlerts(SearchModelMonitoringAlertsRequest request)

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

  • searchModelMonitoringAlerts(ModelMonitorName modelMonitor)

  • searchModelMonitoringAlerts(String modelMonitor)

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

  • searchModelMonitoringAlertsPagedCallable()

  • searchModelMonitoringAlertsCallable()

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

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

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 ModelMonitoringServiceSettings 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
 ModelMonitoringServiceSettings modelMonitoringServiceSettings =
     ModelMonitoringServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create(modelMonitoringServiceSettings);
 

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
 ModelMonitoringServiceSettings modelMonitoringServiceSettings =
     ModelMonitoringServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create(modelMonitoringServiceSettings);
 

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

Inheritance

java.lang.Object > ModelMonitoringServiceClient

Static Methods

create()

public static final ModelMonitoringServiceClient create()

Constructs an instance of ModelMonitoringServiceClient with default settings.

Returns
Type Description
ModelMonitoringServiceClient
Exceptions
Type Description
IOException

create(ModelMonitoringServiceSettings settings)

public static final ModelMonitoringServiceClient create(ModelMonitoringServiceSettings settings)

Constructs an instance of ModelMonitoringServiceClient, 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 ModelMonitoringServiceSettings
Returns
Type Description
ModelMonitoringServiceClient
Exceptions
Type Description
IOException

create(ModelMonitoringServiceStub stub)

public static final ModelMonitoringServiceClient create(ModelMonitoringServiceStub stub)

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

Parameter
Name Description
stub ModelMonitoringServiceStub
Returns
Type Description
ModelMonitoringServiceClient

Constructors

ModelMonitoringServiceClient(ModelMonitoringServiceSettings settings)

protected ModelMonitoringServiceClient(ModelMonitoringServiceSettings settings)

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

ModelMonitoringServiceClient(ModelMonitoringServiceStub stub)

protected ModelMonitoringServiceClient(ModelMonitoringServiceStub stub)
Parameter
Name Description
stub ModelMonitoringServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

createModelMonitorAsync(CreateModelMonitorRequest request)

public final OperationFuture<ModelMonitor,CreateModelMonitorOperationMetadata> createModelMonitorAsync(CreateModelMonitorRequest request)

Creates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   CreateModelMonitorRequest request =
       CreateModelMonitorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModelMonitor(ModelMonitor.newBuilder().build())
           .setModelMonitorId("modelMonitorId2093120236")
           .build();
   ModelMonitor response = modelMonitoringServiceClient.createModelMonitorAsync(request).get();
 }
 
Parameter
Name Description
request CreateModelMonitorRequest

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

Returns
Type Description
OperationFuture<ModelMonitor,CreateModelMonitorOperationMetadata>

createModelMonitorAsync(LocationName parent, ModelMonitor modelMonitor)

public final OperationFuture<ModelMonitor,CreateModelMonitorOperationMetadata> createModelMonitorAsync(LocationName parent, ModelMonitor modelMonitor)

Creates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ModelMonitor modelMonitor = ModelMonitor.newBuilder().build();
   ModelMonitor response =
       modelMonitoringServiceClient.createModelMonitorAsync(parent, modelMonitor).get();
 }
 
Parameters
Name Description
parent LocationName

Required. The resource name of the Location to create the ModelMonitor in. Format: projects/{project}/locations/{location}

modelMonitor ModelMonitor

Required. The ModelMonitor to create.

Returns
Type Description
OperationFuture<ModelMonitor,CreateModelMonitorOperationMetadata>

createModelMonitorAsync(String parent, ModelMonitor modelMonitor)

public final OperationFuture<ModelMonitor,CreateModelMonitorOperationMetadata> createModelMonitorAsync(String parent, ModelMonitor modelMonitor)

Creates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ModelMonitor modelMonitor = ModelMonitor.newBuilder().build();
   ModelMonitor response =
       modelMonitoringServiceClient.createModelMonitorAsync(parent, modelMonitor).get();
 }
 
Parameters
Name Description
parent String

Required. The resource name of the Location to create the ModelMonitor in. Format: projects/{project}/locations/{location}

modelMonitor ModelMonitor

Required. The ModelMonitor to create.

Returns
Type Description
OperationFuture<ModelMonitor,CreateModelMonitorOperationMetadata>

createModelMonitorCallable()

public final UnaryCallable<CreateModelMonitorRequest,Operation> createModelMonitorCallable()

Creates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   CreateModelMonitorRequest request =
       CreateModelMonitorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModelMonitor(ModelMonitor.newBuilder().build())
           .setModelMonitorId("modelMonitorId2093120236")
           .build();
   ApiFuture<Operation> future =
       modelMonitoringServiceClient.createModelMonitorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateModelMonitorRequest,Operation>

createModelMonitorOperationCallable()

public final OperationCallable<CreateModelMonitorRequest,ModelMonitor,CreateModelMonitorOperationMetadata> createModelMonitorOperationCallable()

Creates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   CreateModelMonitorRequest request =
       CreateModelMonitorRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setModelMonitor(ModelMonitor.newBuilder().build())
           .setModelMonitorId("modelMonitorId2093120236")
           .build();
   OperationFuture<ModelMonitor, CreateModelMonitorOperationMetadata> future =
       modelMonitoringServiceClient.createModelMonitorOperationCallable().futureCall(request);
   // Do something.
   ModelMonitor response = future.get();
 }
 
Returns
Type Description
OperationCallable<CreateModelMonitorRequest,ModelMonitor,CreateModelMonitorOperationMetadata>

createModelMonitoringJob(CreateModelMonitoringJobRequest request)

public final ModelMonitoringJob createModelMonitoringJob(CreateModelMonitoringJobRequest request)

Creates a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   CreateModelMonitoringJobRequest request =
       CreateModelMonitoringJobRequest.newBuilder()
           .setParent(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setModelMonitoringJob(ModelMonitoringJob.newBuilder().build())
           .setModelMonitoringJobId("modelMonitoringJobId-1595185177")
           .build();
   ModelMonitoringJob response = modelMonitoringServiceClient.createModelMonitoringJob(request);
 }
 
Parameter
Name Description
request CreateModelMonitoringJobRequest

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

Returns
Type Description
ModelMonitoringJob

createModelMonitoringJob(ModelMonitorName parent, ModelMonitoringJob modelMonitoringJob)

public final ModelMonitoringJob createModelMonitoringJob(ModelMonitorName parent, ModelMonitoringJob modelMonitoringJob)

Creates a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName parent = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   ModelMonitoringJob modelMonitoringJob = ModelMonitoringJob.newBuilder().build();
   ModelMonitoringJob response =
       modelMonitoringServiceClient.createModelMonitoringJob(parent, modelMonitoringJob);
 }
 
Parameters
Name Description
parent ModelMonitorName

Required. The parent of the ModelMonitoringJob. Format: projects/{project}/locations/{location}/modelMoniitors/{model_monitor}

modelMonitoringJob ModelMonitoringJob

Required. The ModelMonitoringJob to create

Returns
Type Description
ModelMonitoringJob

createModelMonitoringJob(String parent, ModelMonitoringJob modelMonitoringJob)

public final ModelMonitoringJob createModelMonitoringJob(String parent, ModelMonitoringJob modelMonitoringJob)

Creates a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String parent = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString();
   ModelMonitoringJob modelMonitoringJob = ModelMonitoringJob.newBuilder().build();
   ModelMonitoringJob response =
       modelMonitoringServiceClient.createModelMonitoringJob(parent, modelMonitoringJob);
 }
 
Parameters
Name Description
parent String

Required. The parent of the ModelMonitoringJob. Format: projects/{project}/locations/{location}/modelMoniitors/{model_monitor}

modelMonitoringJob ModelMonitoringJob

Required. The ModelMonitoringJob to create

Returns
Type Description
ModelMonitoringJob

createModelMonitoringJobCallable()

public final UnaryCallable<CreateModelMonitoringJobRequest,ModelMonitoringJob> createModelMonitoringJobCallable()

Creates a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   CreateModelMonitoringJobRequest request =
       CreateModelMonitoringJobRequest.newBuilder()
           .setParent(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setModelMonitoringJob(ModelMonitoringJob.newBuilder().build())
           .setModelMonitoringJobId("modelMonitoringJobId-1595185177")
           .build();
   ApiFuture<ModelMonitoringJob> future =
       modelMonitoringServiceClient.createModelMonitoringJobCallable().futureCall(request);
   // Do something.
   ModelMonitoringJob response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateModelMonitoringJobRequest,ModelMonitoringJob>

deleteModelMonitorAsync(DeleteModelMonitorRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelMonitorAsync(DeleteModelMonitorRequest request)

Deletes a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   DeleteModelMonitorRequest request =
       DeleteModelMonitorRequest.newBuilder()
           .setName(ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setForce(true)
           .build();
   modelMonitoringServiceClient.deleteModelMonitorAsync(request).get();
 }
 
Parameter
Name Description
request DeleteModelMonitorRequest

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

Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelMonitorAsync(ModelMonitorName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelMonitorAsync(ModelMonitorName name)

Deletes a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName name = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   modelMonitoringServiceClient.deleteModelMonitorAsync(name).get();
 }
 
Parameter
Name Description
name ModelMonitorName

Required. The name of the ModelMonitor resource to be deleted. Format: projects/{project}/locations/{location}/modelMonitords/{model_monitor}

Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelMonitorAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelMonitorAsync(String name)

Deletes a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String name = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString();
   modelMonitoringServiceClient.deleteModelMonitorAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The name of the ModelMonitor resource to be deleted. Format: projects/{project}/locations/{location}/modelMonitords/{model_monitor}

Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelMonitorCallable()

public final UnaryCallable<DeleteModelMonitorRequest,Operation> deleteModelMonitorCallable()

Deletes a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   DeleteModelMonitorRequest request =
       DeleteModelMonitorRequest.newBuilder()
           .setName(ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       modelMonitoringServiceClient.deleteModelMonitorCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteModelMonitorRequest,Operation>

deleteModelMonitorOperationCallable()

public final OperationCallable<DeleteModelMonitorRequest,Empty,DeleteOperationMetadata> deleteModelMonitorOperationCallable()

Deletes a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   DeleteModelMonitorRequest request =
       DeleteModelMonitorRequest.newBuilder()
           .setName(ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       modelMonitoringServiceClient.deleteModelMonitorOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteModelMonitorRequest,Empty,DeleteOperationMetadata>

deleteModelMonitoringJobAsync(DeleteModelMonitoringJobRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelMonitoringJobAsync(DeleteModelMonitoringJobRequest request)

Deletes a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   DeleteModelMonitoringJobRequest request =
       DeleteModelMonitoringJobRequest.newBuilder()
           .setName(
               ModelMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
                   .toString())
           .build();
   modelMonitoringServiceClient.deleteModelMonitoringJobAsync(request).get();
 }
 
Parameter
Name Description
request DeleteModelMonitoringJobRequest

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

Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelMonitoringJobAsync(ModelMonitoringJobName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelMonitoringJobAsync(ModelMonitoringJobName name)

Deletes a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitoringJobName name =
       ModelMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]");
   modelMonitoringServiceClient.deleteModelMonitoringJobAsync(name).get();
 }
 
Parameter
Name Description
name ModelMonitoringJobName

Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelMonitoringJobAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteModelMonitoringJobAsync(String name)

Deletes a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String name =
       ModelMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
           .toString();
   modelMonitoringServiceClient.deleteModelMonitoringJobAsync(name).get();
 }
 
Parameter
Name Description
name String

Required. The resource name of the model monitoring job to delete. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

Returns
Type Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteModelMonitoringJobCallable()

public final UnaryCallable<DeleteModelMonitoringJobRequest,Operation> deleteModelMonitoringJobCallable()

Deletes a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   DeleteModelMonitoringJobRequest request =
       DeleteModelMonitoringJobRequest.newBuilder()
           .setName(
               ModelMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       modelMonitoringServiceClient.deleteModelMonitoringJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteModelMonitoringJobRequest,Operation>

deleteModelMonitoringJobOperationCallable()

public final OperationCallable<DeleteModelMonitoringJobRequest,Empty,DeleteOperationMetadata> deleteModelMonitoringJobOperationCallable()

Deletes a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   DeleteModelMonitoringJobRequest request =
       DeleteModelMonitoringJobRequest.newBuilder()
           .setName(
               ModelMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
                   .toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       modelMonitoringServiceClient
           .deleteModelMonitoringJobOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
OperationCallable<DeleteModelMonitoringJobRequest,Empty,DeleteOperationMetadata>

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = modelMonitoringServiceClient.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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       modelMonitoringServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = modelMonitoringServiceClient.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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       modelMonitoringServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getModelMonitor(GetModelMonitorRequest request)

public final ModelMonitor getModelMonitor(GetModelMonitorRequest request)

Gets a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetModelMonitorRequest request =
       GetModelMonitorRequest.newBuilder()
           .setName(ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .build();
   ModelMonitor response = modelMonitoringServiceClient.getModelMonitor(request);
 }
 
Parameter
Name Description
request GetModelMonitorRequest

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

Returns
Type Description
ModelMonitor

getModelMonitor(ModelMonitorName name)

public final ModelMonitor getModelMonitor(ModelMonitorName name)

Gets a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName name = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   ModelMonitor response = modelMonitoringServiceClient.getModelMonitor(name);
 }
 
Parameter
Name Description
name ModelMonitorName

Required. The name of the ModelMonitor resource. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitor

getModelMonitor(String name)

public final ModelMonitor getModelMonitor(String name)

Gets a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String name = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString();
   ModelMonitor response = modelMonitoringServiceClient.getModelMonitor(name);
 }
 
Parameter
Name Description
name String

Required. The name of the ModelMonitor resource. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitor

getModelMonitorCallable()

public final UnaryCallable<GetModelMonitorRequest,ModelMonitor> getModelMonitorCallable()

Gets a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetModelMonitorRequest request =
       GetModelMonitorRequest.newBuilder()
           .setName(ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .build();
   ApiFuture<ModelMonitor> future =
       modelMonitoringServiceClient.getModelMonitorCallable().futureCall(request);
   // Do something.
   ModelMonitor response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetModelMonitorRequest,ModelMonitor>

getModelMonitoringJob(GetModelMonitoringJobRequest request)

public final ModelMonitoringJob getModelMonitoringJob(GetModelMonitoringJobRequest request)

Gets a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetModelMonitoringJobRequest request =
       GetModelMonitoringJobRequest.newBuilder()
           .setName(
               ModelMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
                   .toString())
           .build();
   ModelMonitoringJob response = modelMonitoringServiceClient.getModelMonitoringJob(request);
 }
 
Parameter
Name Description
request GetModelMonitoringJobRequest

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

Returns
Type Description
ModelMonitoringJob

getModelMonitoringJob(ModelMonitoringJobName name)

public final ModelMonitoringJob getModelMonitoringJob(ModelMonitoringJobName name)

Gets a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitoringJobName name =
       ModelMonitoringJobName.of(
           "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]");
   ModelMonitoringJob response = modelMonitoringServiceClient.getModelMonitoringJob(name);
 }
 
Parameter
Name Description
name ModelMonitoringJobName

Required. The resource name of the ModelMonitoringJob. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

Returns
Type Description
ModelMonitoringJob

getModelMonitoringJob(String name)

public final ModelMonitoringJob getModelMonitoringJob(String name)

Gets a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String name =
       ModelMonitoringJobName.of(
               "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
           .toString();
   ModelMonitoringJob response = modelMonitoringServiceClient.getModelMonitoringJob(name);
 }
 
Parameter
Name Description
name String

Required. The resource name of the ModelMonitoringJob. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}

Returns
Type Description
ModelMonitoringJob

getModelMonitoringJobCallable()

public final UnaryCallable<GetModelMonitoringJobRequest,ModelMonitoringJob> getModelMonitoringJobCallable()

Gets a ModelMonitoringJob.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   GetModelMonitoringJobRequest request =
       GetModelMonitoringJobRequest.newBuilder()
           .setName(
               ModelMonitoringJobName.of(
                       "[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]", "[MODEL_MONITORING_JOB]")
                   .toString())
           .build();
   ApiFuture<ModelMonitoringJob> future =
       modelMonitoringServiceClient.getModelMonitoringJobCallable().futureCall(request);
   // Do something.
   ModelMonitoringJob response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetModelMonitoringJobRequest,ModelMonitoringJob>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getSettings()

public final ModelMonitoringServiceSettings getSettings()
Returns
Type Description
ModelMonitoringServiceSettings

getStub()

public ModelMonitoringServiceStub getStub()
Returns
Type Description
ModelMonitoringServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

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

listLocationsPagedCallable()

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

listModelMonitoringJobs(ListModelMonitoringJobsRequest request)

public final ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse listModelMonitoringJobs(ListModelMonitoringJobsRequest request)

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ListModelMonitoringJobsRequest request =
       ListModelMonitoringJobsRequest.newBuilder()
           .setParent(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (ModelMonitoringJob element :
       modelMonitoringServiceClient.listModelMonitoringJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListModelMonitoringJobsRequest

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

Returns
Type Description
ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse

listModelMonitoringJobs(ModelMonitorName parent)

public final ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse listModelMonitoringJobs(ModelMonitorName parent)

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName parent = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   for (ModelMonitoringJob element :
       modelMonitoringServiceClient.listModelMonitoringJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent ModelMonitorName

Required. The parent of the ModelMonitoringJob. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse

listModelMonitoringJobs(String parent)

public final ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse listModelMonitoringJobs(String parent)

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String parent = ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString();
   for (ModelMonitoringJob element :
       modelMonitoringServiceClient.listModelMonitoringJobs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The parent of the ModelMonitoringJob. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse

listModelMonitoringJobsCallable()

public final UnaryCallable<ListModelMonitoringJobsRequest,ListModelMonitoringJobsResponse> listModelMonitoringJobsCallable()

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ListModelMonitoringJobsRequest request =
       ListModelMonitoringJobsRequest.newBuilder()
           .setParent(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListModelMonitoringJobsResponse response =
         modelMonitoringServiceClient.listModelMonitoringJobsCallable().call(request);
     for (ModelMonitoringJob element : response.getModelMonitoringJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListModelMonitoringJobsRequest,ListModelMonitoringJobsResponse>

listModelMonitoringJobsPagedCallable()

public final UnaryCallable<ListModelMonitoringJobsRequest,ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse> listModelMonitoringJobsPagedCallable()

Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ListModelMonitoringJobsRequest request =
       ListModelMonitoringJobsRequest.newBuilder()
           .setParent(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ModelMonitoringJob> future =
       modelMonitoringServiceClient.listModelMonitoringJobsPagedCallable().futureCall(request);
   // Do something.
   for (ModelMonitoringJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListModelMonitoringJobsRequest,ListModelMonitoringJobsPagedResponse>

listModelMonitors(ListModelMonitorsRequest request)

public final ModelMonitoringServiceClient.ListModelMonitorsPagedResponse listModelMonitors(ListModelMonitorsRequest request)

Lists ModelMonitors in 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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ListModelMonitorsRequest request =
       ListModelMonitorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (ModelMonitor element :
       modelMonitoringServiceClient.listModelMonitors(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListModelMonitorsRequest

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

Returns
Type Description
ModelMonitoringServiceClient.ListModelMonitorsPagedResponse

listModelMonitors(LocationName parent)

public final ModelMonitoringServiceClient.ListModelMonitorsPagedResponse listModelMonitors(LocationName parent)

Lists ModelMonitors in 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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ModelMonitor element :
       modelMonitoringServiceClient.listModelMonitors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent LocationName

Required. The resource name of the Location to list the ModelMonitors from. Format: projects/{project}/locations/{location}

Returns
Type Description
ModelMonitoringServiceClient.ListModelMonitorsPagedResponse

listModelMonitors(String parent)

public final ModelMonitoringServiceClient.ListModelMonitorsPagedResponse listModelMonitors(String parent)

Lists ModelMonitors in 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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ModelMonitor element :
       modelMonitoringServiceClient.listModelMonitors(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The resource name of the Location to list the ModelMonitors from. Format: projects/{project}/locations/{location}

Returns
Type Description
ModelMonitoringServiceClient.ListModelMonitorsPagedResponse

listModelMonitorsCallable()

public final UnaryCallable<ListModelMonitorsRequest,ListModelMonitorsResponse> listModelMonitorsCallable()

Lists ModelMonitors in 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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ListModelMonitorsRequest request =
       ListModelMonitorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListModelMonitorsResponse response =
         modelMonitoringServiceClient.listModelMonitorsCallable().call(request);
     for (ModelMonitor element : response.getModelMonitorsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListModelMonitorsRequest,ListModelMonitorsResponse>

listModelMonitorsPagedCallable()

public final UnaryCallable<ListModelMonitorsRequest,ModelMonitoringServiceClient.ListModelMonitorsPagedResponse> listModelMonitorsPagedCallable()

Lists ModelMonitors in 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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ListModelMonitorsRequest request =
       ListModelMonitorsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ModelMonitor> future =
       modelMonitoringServiceClient.listModelMonitorsPagedCallable().futureCall(request);
   // Do something.
   for (ModelMonitor element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListModelMonitorsRequest,ListModelMonitorsPagedResponse>

searchModelMonitoringAlerts(ModelMonitorName modelMonitor)

public final ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse searchModelMonitoringAlerts(ModelMonitorName modelMonitor)

Returns the Model Monitoring alerts.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName modelMonitor =
       ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   for (ModelMonitoringAlert element :
       modelMonitoringServiceClient.searchModelMonitoringAlerts(modelMonitor).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
modelMonitor ModelMonitorName

Required. ModelMonitor resource name. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse

searchModelMonitoringAlerts(SearchModelMonitoringAlertsRequest request)

public final ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse searchModelMonitoringAlerts(SearchModelMonitoringAlertsRequest request)

Returns the Model Monitoring alerts.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SearchModelMonitoringAlertsRequest request =
       SearchModelMonitoringAlertsRequest.newBuilder()
           .setModelMonitor(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setModelMonitoringJob("modelMonitoringJob1196104108")
           .setAlertTimeInterval(Interval.newBuilder().build())
           .setStatsName("statsName-2073146422")
           .setObjectiveType("objectiveType1316845587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ModelMonitoringAlert element :
       modelMonitoringServiceClient.searchModelMonitoringAlerts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request SearchModelMonitoringAlertsRequest

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

Returns
Type Description
ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse

searchModelMonitoringAlerts(String modelMonitor)

public final ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse searchModelMonitoringAlerts(String modelMonitor)

Returns the Model Monitoring alerts.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String modelMonitor =
       ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString();
   for (ModelMonitoringAlert element :
       modelMonitoringServiceClient.searchModelMonitoringAlerts(modelMonitor).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
modelMonitor String

Required. ModelMonitor resource name. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse

searchModelMonitoringAlertsCallable()

public final UnaryCallable<SearchModelMonitoringAlertsRequest,SearchModelMonitoringAlertsResponse> searchModelMonitoringAlertsCallable()

Returns the Model Monitoring alerts.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SearchModelMonitoringAlertsRequest request =
       SearchModelMonitoringAlertsRequest.newBuilder()
           .setModelMonitor(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setModelMonitoringJob("modelMonitoringJob1196104108")
           .setAlertTimeInterval(Interval.newBuilder().build())
           .setStatsName("statsName-2073146422")
           .setObjectiveType("objectiveType1316845587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchModelMonitoringAlertsResponse response =
         modelMonitoringServiceClient.searchModelMonitoringAlertsCallable().call(request);
     for (ModelMonitoringAlert element : response.getModelMonitoringAlertsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<SearchModelMonitoringAlertsRequest,SearchModelMonitoringAlertsResponse>

searchModelMonitoringAlertsPagedCallable()

public final UnaryCallable<SearchModelMonitoringAlertsRequest,ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse> searchModelMonitoringAlertsPagedCallable()

Returns the Model Monitoring alerts.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SearchModelMonitoringAlertsRequest request =
       SearchModelMonitoringAlertsRequest.newBuilder()
           .setModelMonitor(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setModelMonitoringJob("modelMonitoringJob1196104108")
           .setAlertTimeInterval(Interval.newBuilder().build())
           .setStatsName("statsName-2073146422")
           .setObjectiveType("objectiveType1316845587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ModelMonitoringAlert> future =
       modelMonitoringServiceClient
           .searchModelMonitoringAlertsPagedCallable()
           .futureCall(request);
   // Do something.
   for (ModelMonitoringAlert element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<SearchModelMonitoringAlertsRequest,SearchModelMonitoringAlertsPagedResponse>

searchModelMonitoringStats(ModelMonitorName modelMonitor)

public final ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse searchModelMonitoringStats(ModelMonitorName modelMonitor)

Searches Model Monitoring Stats generated within a given time window.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitorName modelMonitor =
       ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]");
   for (ModelMonitoringStats element :
       modelMonitoringServiceClient.searchModelMonitoringStats(modelMonitor).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
modelMonitor ModelMonitorName

Required. ModelMonitor resource name. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse

searchModelMonitoringStats(SearchModelMonitoringStatsRequest request)

public final ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse searchModelMonitoringStats(SearchModelMonitoringStatsRequest request)

Searches Model Monitoring Stats generated within a given time window.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SearchModelMonitoringStatsRequest request =
       SearchModelMonitoringStatsRequest.newBuilder()
           .setModelMonitor(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setStatsFilter(SearchModelMonitoringStatsFilter.newBuilder().build())
           .setTimeInterval(Interval.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ModelMonitoringStats element :
       modelMonitoringServiceClient.searchModelMonitoringStats(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request SearchModelMonitoringStatsRequest

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

Returns
Type Description
ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse

searchModelMonitoringStats(String modelMonitor)

public final ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse searchModelMonitoringStats(String modelMonitor)

Searches Model Monitoring Stats generated within a given time window.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   String modelMonitor =
       ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString();
   for (ModelMonitoringStats element :
       modelMonitoringServiceClient.searchModelMonitoringStats(modelMonitor).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
modelMonitor String

Required. ModelMonitor resource name. Format: projects/{project}/locations/{location}/modelMonitors/{model_monitor}

Returns
Type Description
ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse

searchModelMonitoringStatsCallable()

public final UnaryCallable<SearchModelMonitoringStatsRequest,SearchModelMonitoringStatsResponse> searchModelMonitoringStatsCallable()

Searches Model Monitoring Stats generated within a given time window.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SearchModelMonitoringStatsRequest request =
       SearchModelMonitoringStatsRequest.newBuilder()
           .setModelMonitor(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setStatsFilter(SearchModelMonitoringStatsFilter.newBuilder().build())
           .setTimeInterval(Interval.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchModelMonitoringStatsResponse response =
         modelMonitoringServiceClient.searchModelMonitoringStatsCallable().call(request);
     for (ModelMonitoringStats element : response.getMonitoringStatsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<SearchModelMonitoringStatsRequest,SearchModelMonitoringStatsResponse>

searchModelMonitoringStatsPagedCallable()

public final UnaryCallable<SearchModelMonitoringStatsRequest,ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse> searchModelMonitoringStatsPagedCallable()

Searches Model Monitoring Stats generated within a given time window.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SearchModelMonitoringStatsRequest request =
       SearchModelMonitoringStatsRequest.newBuilder()
           .setModelMonitor(
               ModelMonitorName.of("[PROJECT]", "[LOCATION]", "[MODEL_MONITOR]").toString())
           .setStatsFilter(SearchModelMonitoringStatsFilter.newBuilder().build())
           .setTimeInterval(Interval.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ModelMonitoringStats> future =
       modelMonitoringServiceClient
           .searchModelMonitoringStatsPagedCallable()
           .futureCall(request);
   // Do something.
   for (ModelMonitoringStats element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<SearchModelMonitoringStatsRequest,SearchModelMonitoringStatsPagedResponse>

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

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = modelMonitoringServiceClient.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_DENIEDerrors.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       modelMonitoringServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       modelMonitoringServiceClient.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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       modelMonitoringServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateModelMonitorAsync(ModelMonitor modelMonitor, FieldMask updateMask)

public final OperationFuture<ModelMonitor,UpdateModelMonitorOperationMetadata> updateModelMonitorAsync(ModelMonitor modelMonitor, FieldMask updateMask)

Updates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   ModelMonitor modelMonitor = ModelMonitor.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ModelMonitor response =
       modelMonitoringServiceClient.updateModelMonitorAsync(modelMonitor, updateMask).get();
 }
 
Parameters
Name Description
modelMonitor ModelMonitor

Required. The model monitoring configuration which replaces the resource on the server.

updateMask FieldMask

Required. Mask specifying which fields to update.

Returns
Type Description
OperationFuture<ModelMonitor,UpdateModelMonitorOperationMetadata>

updateModelMonitorAsync(UpdateModelMonitorRequest request)

public final OperationFuture<ModelMonitor,UpdateModelMonitorOperationMetadata> updateModelMonitorAsync(UpdateModelMonitorRequest request)

Updates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   UpdateModelMonitorRequest request =
       UpdateModelMonitorRequest.newBuilder()
           .setModelMonitor(ModelMonitor.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ModelMonitor response = modelMonitoringServiceClient.updateModelMonitorAsync(request).get();
 }
 
Parameter
Name Description
request UpdateModelMonitorRequest

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

Returns
Type Description
OperationFuture<ModelMonitor,UpdateModelMonitorOperationMetadata>

updateModelMonitorCallable()

public final UnaryCallable<UpdateModelMonitorRequest,Operation> updateModelMonitorCallable()

Updates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   UpdateModelMonitorRequest request =
       UpdateModelMonitorRequest.newBuilder()
           .setModelMonitor(ModelMonitor.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       modelMonitoringServiceClient.updateModelMonitorCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateModelMonitorRequest,Operation>

updateModelMonitorOperationCallable()

public final OperationCallable<UpdateModelMonitorRequest,ModelMonitor,UpdateModelMonitorOperationMetadata> updateModelMonitorOperationCallable()

Updates a ModelMonitor.

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 (ModelMonitoringServiceClient modelMonitoringServiceClient =
     ModelMonitoringServiceClient.create()) {
   UpdateModelMonitorRequest request =
       UpdateModelMonitorRequest.newBuilder()
           .setModelMonitor(ModelMonitor.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<ModelMonitor, UpdateModelMonitorOperationMetadata> future =
       modelMonitoringServiceClient.updateModelMonitorOperationCallable().futureCall(request);
   // Do something.
   ModelMonitor response = future.get();
 }
 
Returns
Type Description
OperationCallable<UpdateModelMonitorRequest,ModelMonitor,UpdateModelMonitorOperationMetadata>