AlertPolicyServiceClient (Google Cloud Monitoring 3.79.0 API)

java.lang.Object
- com.google.cloud.monitoring.v3.AlertPolicyServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class AlertPolicyServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Cloud Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through [Cloud Monitoring](https://cloud.google.com/monitoring/docs/), which can be reached by clicking the "Monitoring" tab in [Cloud console](https://console.cloud.google.com/).

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 (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   AlertPolicyName name =
       AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]");
   AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(name);
 }

Note: close() needs to be called on the AlertPolicyServiceClient 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
ListAlertPolicies	Lists the existing alerting policies for the workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAlertPolicies(ListAlertPoliciesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAlertPolicies(ResourceName name) listAlertPolicies(OrganizationName name) listAlertPolicies(ProjectName name) listAlertPolicies(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. listAlertPoliciesPagedCallable() listAlertPoliciesCallable()
GetAlertPolicy	Gets a single alerting policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAlertPolicy(GetAlertPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAlertPolicy(AlertPolicyName name) getAlertPolicy(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. getAlertPolicyCallable()
CreateAlertPolicy	Creates a new alerting policy. Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAlertPolicy(CreateAlertPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createAlertPolicy(ResourceName name, AlertPolicy alertPolicy) createAlertPolicy(OrganizationName name, AlertPolicy alertPolicy) createAlertPolicy(ProjectName name, AlertPolicy alertPolicy) createAlertPolicy(String name, AlertPolicy alertPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAlertPolicyCallable()
DeleteAlertPolicy	Deletes an alerting policy. Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAlertPolicy(DeleteAlertPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteAlertPolicy(AlertPolicyName name) deleteAlertPolicy(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. deleteAlertPolicyCallable()
UpdateAlertPolicy	Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via `updateMask`. Returns the updated alerting policy. Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAlertPolicy(UpdateAlertPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateAlertPolicy(FieldMask updateMask, AlertPolicy alertPolicy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateAlertPolicyCallable()

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 AlertPolicyServiceSettings 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
 AlertPolicyServiceSettings alertPolicyServiceSettings =
     AlertPolicyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AlertPolicyServiceClient alertPolicyServiceClient =
     AlertPolicyServiceClient.create(alertPolicyServiceSettings);

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
 AlertPolicyServiceSettings alertPolicyServiceSettings =
     AlertPolicyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AlertPolicyServiceClient alertPolicyServiceClient =
     AlertPolicyServiceClient.create(alertPolicyServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AlertPolicyServiceClient.ListAlertPoliciesFixedSizeCollection`
`static class`	`AlertPolicyServiceClient.ListAlertPoliciesPage`
`static class`	`AlertPolicyServiceClient.ListAlertPoliciesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AlertPolicyServiceClient(AlertPolicyServiceSettings settings)` Constructs an instance of AlertPolicyServiceClient, using the given settings.
`protected`	`AlertPolicyServiceClient(AlertPolicyServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static AlertPolicyServiceClient`	`create()` Constructs an instance of AlertPolicyServiceClient with default settings.
`static AlertPolicyServiceClient`	`create(AlertPolicyServiceSettings settings)` Constructs an instance of AlertPolicyServiceClient, using the given settings.
`static AlertPolicyServiceClient`	`create(AlertPolicyServiceStub stub)` Constructs an instance of AlertPolicyServiceClient, using the given stub for making calls.
`AlertPolicy`	`createAlertPolicy(CreateAlertPolicyRequest request)` Creates a new alerting policy.
`AlertPolicy`	`createAlertPolicy(OrganizationName name, AlertPolicy alertPolicy)` Creates a new alerting policy.
`AlertPolicy`	`createAlertPolicy(ProjectName name, AlertPolicy alertPolicy)` Creates a new alerting policy.
`AlertPolicy`	`createAlertPolicy(com.google.api.resourcenames.ResourceName name, AlertPolicy alertPolicy)` Creates a new alerting policy.
`AlertPolicy`	`createAlertPolicy(String name, AlertPolicy alertPolicy)` Creates a new alerting policy.
`com.google.api.gax.rpc.UnaryCallable<CreateAlertPolicyRequest,AlertPolicy>`	`createAlertPolicyCallable()` Creates a new alerting policy.
`void`	`deleteAlertPolicy(AlertPolicyName name)` Deletes an alerting policy.
`void`	`deleteAlertPolicy(DeleteAlertPolicyRequest request)` Deletes an alerting policy.
`void`	`deleteAlertPolicy(String name)` Deletes an alerting policy.
`com.google.api.gax.rpc.UnaryCallable<DeleteAlertPolicyRequest,com.google.protobuf.Empty>`	`deleteAlertPolicyCallable()` Deletes an alerting policy.
`AlertPolicy`	`getAlertPolicy(AlertPolicyName name)` Gets a single alerting policy.
`AlertPolicy`	`getAlertPolicy(GetAlertPolicyRequest request)` Gets a single alerting policy.
`AlertPolicy`	`getAlertPolicy(String name)` Gets a single alerting policy.
`com.google.api.gax.rpc.UnaryCallable<GetAlertPolicyRequest,AlertPolicy>`	`getAlertPolicyCallable()` Gets a single alerting policy.
`AlertPolicyServiceSettings`	`getSettings()`
`AlertPolicyServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AlertPolicyServiceClient.ListAlertPoliciesPagedResponse`	`listAlertPolicies(ListAlertPoliciesRequest request)` Lists the existing alerting policies for the workspace.
`AlertPolicyServiceClient.ListAlertPoliciesPagedResponse`	`listAlertPolicies(OrganizationName name)` Lists the existing alerting policies for the workspace.
`AlertPolicyServiceClient.ListAlertPoliciesPagedResponse`	`listAlertPolicies(ProjectName name)` Lists the existing alerting policies for the workspace.
`AlertPolicyServiceClient.ListAlertPoliciesPagedResponse`	`listAlertPolicies(com.google.api.resourcenames.ResourceName name)` Lists the existing alerting policies for the workspace.
`AlertPolicyServiceClient.ListAlertPoliciesPagedResponse`	`listAlertPolicies(String name)` Lists the existing alerting policies for the workspace.
`com.google.api.gax.rpc.UnaryCallable<ListAlertPoliciesRequest,ListAlertPoliciesResponse>`	`listAlertPoliciesCallable()` Lists the existing alerting policies for the workspace.
`com.google.api.gax.rpc.UnaryCallable<ListAlertPoliciesRequest,AlertPolicyServiceClient.ListAlertPoliciesPagedResponse>`	`listAlertPoliciesPagedCallable()` Lists the existing alerting policies for the workspace.
`void`	`shutdown()`
`void`	`shutdownNow()`
`AlertPolicy`	`updateAlertPolicy(com.google.protobuf.FieldMask updateMask, AlertPolicy alertPolicy)` Updates an alerting policy.
`AlertPolicy`	`updateAlertPolicy(UpdateAlertPolicyRequest request)` Updates an alerting policy.
`com.google.api.gax.rpc.UnaryCallable<UpdateAlertPolicyRequest,AlertPolicy>`	`updateAlertPolicyCallable()` Updates an alerting policy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AlertPolicyServiceClient
```
protected AlertPolicyServiceClient(AlertPolicyServiceSettings settings)
                            throws IOException
```
  Constructs an instance of AlertPolicyServiceClient, 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
- AlertPolicyServiceClient
```
protected AlertPolicyServiceClient(AlertPolicyServiceStub stub)
```

Method Detail

create

public static final AlertPolicyServiceClient create()
                                             throws IOException

Constructs an instance of AlertPolicyServiceClient with default settings.

Throws:: IOException

create
```
public static final AlertPolicyServiceClient create(AlertPolicyServiceSettings settings)
                                             throws IOException
```
Constructs an instance of AlertPolicyServiceClient, 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
```
public static final AlertPolicyServiceClient create(AlertPolicyServiceStub stub)
```
Constructs an instance of AlertPolicyServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AlertPolicyServiceSettings).

getSettings

public final AlertPolicyServiceSettings getSettings()

getStub

public AlertPolicyServiceStub getStub()

listAlertPolicies

public final AlertPolicyServiceClient.ListAlertPoliciesPagedResponse listAlertPolicies(com.google.api.resourcenames.ResourceName name)

Lists the existing alerting policies for the workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ResourceName name = ResourceName.of("[FOLDER]");
   for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation, instead.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAlertPolicies

public final AlertPolicyServiceClient.ListAlertPoliciesPagedResponse listAlertPolicies(OrganizationName name)

Lists the existing alerting policies for the workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAlertPolicies

public final AlertPolicyServiceClient.ListAlertPoliciesPagedResponse listAlertPolicies(ProjectName name)

Lists the existing alerting policies for the workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(name).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAlertPolicies

public final AlertPolicyServiceClient.ListAlertPoliciesPagedResponse listAlertPolicies(String name)

Lists the existing alerting policies for the workspace.

Sample code:


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

Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listAlertPolicies

public final AlertPolicyServiceClient.ListAlertPoliciesPagedResponse listAlertPolicies(ListAlertPoliciesRequest request)

Lists the existing alerting policies for the workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ListAlertPoliciesRequest request =
       ListAlertPoliciesRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AlertPolicy element : alertPolicyServiceClient.listAlertPolicies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAlertPoliciesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAlertPoliciesRequest,AlertPolicyServiceClient.ListAlertPoliciesPagedResponse> listAlertPoliciesPagedCallable()

Lists the existing alerting policies for the workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ListAlertPoliciesRequest request =
       ListAlertPoliciesRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AlertPolicy> future =
       alertPolicyServiceClient.listAlertPoliciesPagedCallable().futureCall(request);
   // Do something.
   for (AlertPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listAlertPoliciesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAlertPoliciesRequest,ListAlertPoliciesResponse> listAlertPoliciesCallable()

Lists the existing alerting policies for the workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ListAlertPoliciesRequest request =
       ListAlertPoliciesRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAlertPoliciesResponse response =
         alertPolicyServiceClient.listAlertPoliciesCallable().call(request);
     for (AlertPolicy element : response.getAlertPoliciesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getAlertPolicy

public final AlertPolicy getAlertPolicy(AlertPolicyName name)

Gets a single alerting policy.

Sample code:


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

Parameters:: name - Required. The alerting policy to retrieve. The format is:
projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAlertPolicy

public final AlertPolicy getAlertPolicy(String name)

Gets a single alerting policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   String name =
       AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]").toString();
   AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(name);
 }

Parameters:: name - Required. The alerting policy to retrieve. The format is:
projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAlertPolicy

public final AlertPolicy getAlertPolicy(GetAlertPolicyRequest request)

Gets a single alerting policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   GetAlertPolicyRequest request =
       GetAlertPolicyRequest.newBuilder()
           .setName(
               AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
                   .toString())
           .build();
   AlertPolicy response = alertPolicyServiceClient.getAlertPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAlertPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<GetAlertPolicyRequest,AlertPolicy> getAlertPolicyCallable()

Gets a single alerting policy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   GetAlertPolicyRequest request =
       GetAlertPolicyRequest.newBuilder()
           .setName(
               AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
                   .toString())
           .build();
   ApiFuture<AlertPolicy> future =
       alertPolicyServiceClient.getAlertPolicyCallable().futureCall(request);
   // Do something.
   AlertPolicy response = future.get();
 }

createAlertPolicy
```
public final AlertPolicy createAlertPolicy(com.google.api.resourcenames.ResourceName name,
                                           AlertPolicy alertPolicy)
```
Creates a new alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
Sample code:
```
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ResourceName name = ResourceName.of("[FOLDER]");
   AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
   AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
 }
 
```
Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.

alertPolicy - Required. The requested alerting policy. You should omit the `name` field in this policy. The name will be returned in the new policy, including a new `[ALERT_POLICY_ID]` value.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAlertPolicy
```
public final AlertPolicy createAlertPolicy(OrganizationName name,
                                           AlertPolicy alertPolicy)
```
Creates a new alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
Sample code:
```
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   OrganizationName name = OrganizationName.of("[ORGANIZATION]");
   AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
   AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
 }
 
```
Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.

alertPolicy - Required. The requested alerting policy. You should omit the `name` field in this policy. The name will be returned in the new policy, including a new `[ALERT_POLICY_ID]` value.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAlertPolicy
```
public final AlertPolicy createAlertPolicy(ProjectName name,
                                           AlertPolicy alertPolicy)
```
Creates a new alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
Sample code:
```
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   ProjectName name = ProjectName.of("[PROJECT]");
   AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
   AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
 }
 
```
Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.

alertPolicy - Required. The requested alerting policy. You should omit the `name` field in this policy. The name will be returned in the new policy, including a new `[ALERT_POLICY_ID]` value.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAlertPolicy
```
public final AlertPolicy createAlertPolicy(String name,
                                           AlertPolicy alertPolicy)
```
Creates a new alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
Sample code:
```
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   String name = ProjectName.of("[PROJECT]").toString();
   AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
   AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(name, alertPolicy);
 }
 
```
Parameters:

name - Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is:
projects/[PROJECT_ID_OR_NUMBER]
Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope, otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the container.

alertPolicy - Required. The requested alerting policy. You should omit the `name` field in this policy. The name will be returned in the new policy, including a new `[ALERT_POLICY_ID]` value.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAlertPolicy

public final AlertPolicy createAlertPolicy(CreateAlertPolicyRequest request)

Creates a new alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   CreateAlertPolicyRequest request =
       CreateAlertPolicyRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setAlertPolicy(AlertPolicy.newBuilder().build())
           .build();
   AlertPolicy response = alertPolicyServiceClient.createAlertPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createAlertPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateAlertPolicyRequest,AlertPolicy> createAlertPolicyCallable()

Creates a new alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   CreateAlertPolicyRequest request =
       CreateAlertPolicyRequest.newBuilder()
           .setName(ProjectName.of("[PROJECT]").toString())
           .setAlertPolicy(AlertPolicy.newBuilder().build())
           .build();
   ApiFuture<AlertPolicy> future =
       alertPolicyServiceClient.createAlertPolicyCallable().futureCall(request);
   // Do something.
   AlertPolicy response = future.get();
 }

deleteAlertPolicy

public final void deleteAlertPolicy(AlertPolicyName name)

Deletes an alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


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

Parameters:

name - Required. The alerting policy to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAlertPolicy

public final void deleteAlertPolicy(String name)

Deletes an alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   String name =
       AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]").toString();
   alertPolicyServiceClient.deleteAlertPolicy(name);
 }

Parameters:

name - Required. The alerting policy to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]

For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAlertPolicy

public final void deleteAlertPolicy(DeleteAlertPolicyRequest request)

Deletes an alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   DeleteAlertPolicyRequest request =
       DeleteAlertPolicyRequest.newBuilder()
           .setName(
               AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
                   .toString())
           .build();
   alertPolicyServiceClient.deleteAlertPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAlertPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteAlertPolicyRequest,com.google.protobuf.Empty> deleteAlertPolicyCallable()

Deletes an alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   DeleteAlertPolicyRequest request =
       DeleteAlertPolicyRequest.newBuilder()
           .setName(
               AlertPolicyName.ofProjectAlertPolicyName("[PROJECT]", "[ALERT_POLICY]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       alertPolicyServiceClient.deleteAlertPolicyCallable().futureCall(request);
   // Do something.
   future.get();
 }

updateAlertPolicy
```
public final AlertPolicy updateAlertPolicy(com.google.protobuf.FieldMask updateMask,
                                           AlertPolicy alertPolicy)
```
Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via `updateMask`. Returns the updated alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.
Sample code:
```
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   FieldMask updateMask = FieldMask.newBuilder().build();
   AlertPolicy alertPolicy = AlertPolicy.newBuilder().build();
   AlertPolicy response = alertPolicyServiceClient.updateAlertPolicy(updateMask, alertPolicy);
 }
 
```
Parameters:

updateMask - Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (`alert_policy`), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.
Examples of valid field masks include `display_name`, `documentation`, `documentation.content`, `documentation.mime_type`, `user_labels`, `user_label.nameofkey`, `enabled`, `conditions`, `combiner`, etc.
If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:
+ The new policy will have the same `[ALERT_POLICY_ID]` as the former policy. This gives you continuity with the former policy in your notifications and incidents. + Conditions in the new policy will keep their former `[CONDITION_ID]` if the supplied condition includes the `name` field with that `[CONDITION_ID]`. If the supplied condition omits the `name` field, then a new `[CONDITION_ID]` is created.

alertPolicy - Required. The updated alerting policy or the updated values for the fields listed in `update_mask`. If `update_mask` is not empty, any fields in this policy that are not in `update_mask` are ignored.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateAlertPolicy

public final AlertPolicy updateAlertPolicy(UpdateAlertPolicyRequest request)

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via `updateMask`. Returns the updated alerting policy.

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   UpdateAlertPolicyRequest request =
       UpdateAlertPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAlertPolicy(AlertPolicy.newBuilder().build())
           .build();
   AlertPolicy response = alertPolicyServiceClient.updateAlertPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateAlertPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateAlertPolicyRequest,AlertPolicy> updateAlertPolicyCallable()

Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AlertPolicyServiceClient alertPolicyServiceClient = AlertPolicyServiceClient.create()) {
   UpdateAlertPolicyRequest request =
       UpdateAlertPolicyRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setAlertPolicy(AlertPolicy.newBuilder().build())
           .build();
   ApiFuture<AlertPolicy> future =
       alertPolicyServiceClient.updateAlertPolicyCallable().futureCall(request);
   // Do something.
   AlertPolicy response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class AlertPolicyServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AlertPolicyServiceClient

AlertPolicyServiceClient

Method Detail

create

create

create

getSettings

getStub

listAlertPolicies

listAlertPolicies

listAlertPolicies

listAlertPolicies

listAlertPolicies

listAlertPoliciesPagedCallable

listAlertPoliciesCallable

getAlertPolicy

getAlertPolicy

getAlertPolicy

getAlertPolicyCallable

createAlertPolicy

createAlertPolicy

createAlertPolicy

createAlertPolicy

createAlertPolicy

createAlertPolicyCallable

deleteAlertPolicy

deleteAlertPolicy

deleteAlertPolicy

deleteAlertPolicyCallable

updateAlertPolicy

updateAlertPolicy

updateAlertPolicyCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination