Class ModelMonitoringServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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().
| 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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateModelMonitor |
Updates a ModelMonitor. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetModelMonitor |
Gets a ModelMonitor. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListModelMonitors |
Lists ModelMonitors in a Location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteModelMonitor |
Deletes a ModelMonitor. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateModelMonitoringJob |
Creates a ModelMonitoringJob. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetModelMonitoringJob |
Gets a ModelMonitoringJob. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListModelMonitoringJobs |
Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteModelMonitoringJob |
Deletes a ModelMonitoringJob. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SearchModelMonitoringAlerts |
Returns the Model Monitoring alerts. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructs an instance of ModelMonitoringServiceClient, using the given settings.protected -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final ModelMonitoringServiceClientcreate()Constructs an instance of ModelMonitoringServiceClient with default settings.static final ModelMonitoringServiceClientcreate(ModelMonitoringServiceSettings settings) Constructs an instance of ModelMonitoringServiceClient, using the given settings.static final ModelMonitoringServiceClientConstructs an instance of ModelMonitoringServiceClient, using the given stub for making calls.Creates a ModelMonitor.createModelMonitorAsync(LocationName parent, ModelMonitor modelMonitor) Creates a ModelMonitor.createModelMonitorAsync(String parent, ModelMonitor modelMonitor) Creates a ModelMonitor.Creates a ModelMonitor.final ModelMonitoringJobCreates a ModelMonitoringJob.final ModelMonitoringJobcreateModelMonitoringJob(ModelMonitorName parent, ModelMonitoringJob modelMonitoringJob) Creates a ModelMonitoringJob.final ModelMonitoringJobcreateModelMonitoringJob(String parent, ModelMonitoringJob modelMonitoringJob) Creates a ModelMonitoringJob.Creates a ModelMonitoringJob.Creates a ModelMonitor.final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> Deletes a ModelMonitor.final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> Deletes a ModelMonitor.final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> Deletes a ModelMonitor.Deletes a ModelMonitor.final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> Deletes a ModelMonitoringJob.final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> Deletes a ModelMonitoringJob.final OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> Deletes a ModelMonitoringJob.Deletes a ModelMonitoringJob.final OperationCallable<DeleteModelMonitoringJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Deletes a ModelMonitoringJob.final OperationCallable<DeleteModelMonitorRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Deletes a ModelMonitor.final PolicygetIamPolicy(GetIamPolicyRequest request) Gets the access control policy for a resource.Gets the access control policy for a resource.final LocationgetLocation(GetLocationRequest request) Gets information about a location.Gets information about a location.final ModelMonitorgetModelMonitor(GetModelMonitorRequest request) Gets a ModelMonitor.final ModelMonitorGets a ModelMonitor.final ModelMonitorgetModelMonitor(String name) Gets a ModelMonitor.Gets a ModelMonitor.final ModelMonitoringJobGets a ModelMonitoringJob.final ModelMonitoringJobGets a ModelMonitoringJob.final ModelMonitoringJobgetModelMonitoringJob(String name) Gets a ModelMonitoringJob.Gets a ModelMonitoringJob.final OperationsClientReturns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.getStub()booleanbooleanlistLocations(ListLocationsRequest request) Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists information about the supported locations for this service.Lists ModelMonitoringJobs.Lists ModelMonitoringJobs.listModelMonitoringJobs(String parent) Lists ModelMonitoringJobs.Lists ModelMonitoringJobs.final UnaryCallable<ListModelMonitoringJobsRequest,ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse> Lists ModelMonitoringJobs.Lists ModelMonitors in a Location.listModelMonitors(LocationName parent) Lists ModelMonitors in a Location.listModelMonitors(String parent) Lists ModelMonitors in a Location.Lists ModelMonitors in a Location.final UnaryCallable<ListModelMonitorsRequest,ModelMonitoringServiceClient.ListModelMonitorsPagedResponse> Lists ModelMonitors in a Location.searchModelMonitoringAlerts(ModelMonitorName modelMonitor) Returns the Model Monitoring alerts.Returns the Model Monitoring alerts.searchModelMonitoringAlerts(String modelMonitor) Returns the Model Monitoring alerts.Returns the Model Monitoring alerts.final UnaryCallable<SearchModelMonitoringAlertsRequest,ModelMonitoringServiceClient.SearchModelMonitoringAlertsPagedResponse> Returns the Model Monitoring alerts.searchModelMonitoringStats(ModelMonitorName modelMonitor) Searches Model Monitoring Stats generated within a given time window.Searches Model Monitoring Stats generated within a given time window.searchModelMonitoringStats(String modelMonitor) Searches Model Monitoring Stats generated within a given time window.Searches Model Monitoring Stats generated within a given time window.final UnaryCallable<SearchModelMonitoringStatsRequest,ModelMonitoringServiceClient.SearchModelMonitoringStatsPagedResponse> Searches Model Monitoring Stats generated within a given time window.final PolicysetIamPolicy(SetIamPolicyRequest request) Sets the access control policy on the specified resource.Sets the access control policy on the specified resource.voidshutdown()voidReturns permissions that a caller has on the specified resource.Returns permissions that a caller has on the specified resource.updateModelMonitorAsync(ModelMonitor modelMonitor, com.google.protobuf.FieldMask updateMask) Updates a ModelMonitor.Updates a ModelMonitor.Updates a ModelMonitor.Updates a ModelMonitor.
-
Constructor Details
-
ModelMonitoringServiceClient
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.- Throws:
IOException
-
ModelMonitoringServiceClient
-
-
Method Details
-
create
Constructs an instance of ModelMonitoringServiceClient with default settings.- Throws:
IOException
-
create
public static final ModelMonitoringServiceClient create(ModelMonitoringServiceSettings settings) throws IOException 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.- Throws:
IOException
-
create
Constructs an instance of ModelMonitoringServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ModelMonitoringServiceSettings). -
getSettings
-
getStub
-
getOperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call. -
createModelMonitorAsync
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:
parent- Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`modelMonitor- Required. The ModelMonitor to create.- Throws:
ApiException- if the remote call fails
-
createModelMonitorAsync
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:
parent- Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`modelMonitor- Required. The ModelMonitor to create.- Throws:
ApiException- if the remote call fails
-
createModelMonitorAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createModelMonitorOperationCallable
public final OperationCallable<CreateModelMonitorRequest,ModelMonitor, createModelMonitorOperationCallable()CreateModelMonitorOperationMetadata> 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(); } -
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(); } -
updateModelMonitorAsync
public final OperationFuture<ModelMonitor,UpdateModelMonitorOperationMetadata> updateModelMonitorAsync(ModelMonitor modelMonitor, com.google.protobuf.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:
modelMonitor- Required. The model monitoring configuration which replaces the resource on the server.updateMask- Required. Mask specifying which fields to update.- Throws:
ApiException- if the remote call fails
-
updateModelMonitorAsync
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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateModelMonitorOperationCallable
public final OperationCallable<UpdateModelMonitorRequest,ModelMonitor, updateModelMonitorOperationCallable()UpdateModelMonitorOperationMetadata> 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(); } -
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(); } -
getModelMonitor
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); }- Parameters:
name- Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
getModelMonitor
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); }- Parameters:
name- Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
getModelMonitor
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listModelMonitors
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); } }- Parameters:
parent- Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listModelMonitors
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); } }- Parameters:
parent- Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`- Throws:
ApiException- if the remote call fails
-
listModelMonitors
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
deleteModelMonitorAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
deleteModelMonitorAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
deleteModelMonitorAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteModelMonitorOperationCallable
public final OperationCallable<DeleteModelMonitorRequest,com.google.protobuf.Empty, deleteModelMonitorOperationCallable()DeleteOperationMetadata> 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(); } -
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(); } -
createModelMonitoringJob
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:
parent- Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`modelMonitoringJob- Required. The ModelMonitoringJob to create- Throws:
ApiException- if the remote call fails
-
createModelMonitoringJob
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:
parent- Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`modelMonitoringJob- Required. The ModelMonitoringJob to create- Throws:
ApiException- if the remote call fails
-
createModelMonitoringJob
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
getModelMonitoringJob
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); }- Parameters:
name- Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`- Throws:
ApiException- if the remote call fails
-
getModelMonitoringJob
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); }- Parameters:
name- Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`- Throws:
ApiException- if the remote call fails
-
getModelMonitoringJob
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
listModelMonitoringJobs
public final ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse listModelMonitoringJobs(ModelMonitorName parent) Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/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); } }- Parameters:
parent- Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
listModelMonitoringJobs
public final ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse listModelMonitoringJobs(String parent) Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/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); } }- Parameters:
parent- Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
listModelMonitoringJobs
public final ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse listModelMonitoringJobs(ListModelMonitoringJobsRequest request) Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
listModelMonitoringJobsPagedCallable
public final UnaryCallable<ListModelMonitoringJobsRequest,ModelMonitoringServiceClient.ListModelMonitoringJobsPagedResponse> listModelMonitoringJobsPagedCallable()Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/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); } } -
listModelMonitoringJobsCallable
public final UnaryCallable<ListModelMonitoringJobsRequest,ListModelMonitoringJobsResponse> listModelMonitoringJobsCallable()Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/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; } } } -
deleteModelMonitoringJobAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`- Throws:
ApiException- if the remote call fails
-
deleteModelMonitoringJobAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
name- Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`- Throws:
ApiException- if the remote call fails
-
deleteModelMonitoringJobAsync
public final OperationFuture<com.google.protobuf.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(); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteModelMonitoringJobOperationCallable
public final OperationCallable<DeleteModelMonitoringJobRequest,com.google.protobuf.Empty, deleteModelMonitoringJobOperationCallable()DeleteOperationMetadata> 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(); } -
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(); } -
searchModelMonitoringStats
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); } }- Parameters:
modelMonitor- Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
searchModelMonitoringStats
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); } }- Parameters:
modelMonitor- Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
searchModelMonitoringStats
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
searchModelMonitoringAlerts
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); } }- Parameters:
modelMonitor- Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
searchModelMonitoringAlerts
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); } }- Parameters:
modelMonitor- Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`- Throws:
ApiException- if the remote call fails
-
searchModelMonitoringAlerts
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
listLocations
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); } }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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); } } -
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; } } } -
getLocation
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
setIamPolicy
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
setIamPolicyCallable
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (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(); } -
getIamPolicy
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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
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.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying 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); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
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(); } -
close
public final void close()- Specified by:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-