- 3.53.0 (latest)
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
GitHub Repository | Product Reference |
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, which can be reached by clicking the "Monitoring" tab in Cloud console.
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().
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.
"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.
|
GetAlertPolicy |
Gets a single alerting policy. |
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.
|
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.
"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.
|
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.
"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.
|
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 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.
"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.
|
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.
Static Methods
create()
public static final AlertPolicyServiceClient create()
Constructs an instance of AlertPolicyServiceClient with default settings.
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(AlertPolicyServiceSettings settings)
public static final AlertPolicyServiceClient create(AlertPolicyServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
AlertPolicyServiceSettings |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(AlertPolicyServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
AlertPolicyServiceStub |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient |
Constructors
AlertPolicyServiceClient(AlertPolicyServiceSettings settings)
protected AlertPolicyServiceClient(AlertPolicyServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
AlertPolicyServiceSettings |
AlertPolicyServiceClient(AlertPolicyServiceStub stub)
protected AlertPolicyServiceClient(AlertPolicyServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
AlertPolicyServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration |
long |
unit |
TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
createAlertPolicy(ResourceName name, AlertPolicy alertPolicy)
public final AlertPolicy createAlertPolicy(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 | Description |
name |
com.google.api.resourcenames.ResourceName Required. The project 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 |
alertPolicy |
AlertPolicy Required. The requested alerting policy. You should omit the |
Returns | |
---|---|
Type | Description |
AlertPolicy |
createAlertPolicy(CreateAlertPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
CreateAlertPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
AlertPolicy |
createAlertPolicy(OrganizationName name, AlertPolicy alertPolicy)
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 | Description |
name |
OrganizationName Required. The project 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 |
alertPolicy |
AlertPolicy Required. The requested alerting policy. You should omit the |
Returns | |
---|---|
Type | Description |
AlertPolicy |
createAlertPolicy(ProjectName name, AlertPolicy alertPolicy)
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 | Description |
name |
ProjectName Required. The project 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 |
alertPolicy |
AlertPolicy Required. The requested alerting policy. You should omit the |
Returns | |
---|---|
Type | Description |
AlertPolicy |
createAlertPolicy(String name, AlertPolicy alertPolicy)
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 | Description |
name |
String Required. The project 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 |
alertPolicy |
AlertPolicy Required. The requested alerting policy. You should omit the |
Returns | |
---|---|
Type | Description |
AlertPolicy |
createAlertPolicyCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateAlertPolicyRequest,AlertPolicy> |
deleteAlertPolicy(AlertPolicyName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
AlertPolicyName Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. |
deleteAlertPolicy(DeleteAlertPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
DeleteAlertPolicyRequest The request object containing all of the parameters for the API call. |
deleteAlertPolicy(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. |
deleteAlertPolicyCallable()
public final UnaryCallable<DeleteAlertPolicyRequest,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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteAlertPolicyRequest,Empty> |
getAlertPolicy(AlertPolicyName name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
AlertPolicyName Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] |
Returns | |
---|---|
Type | Description |
AlertPolicy |
getAlertPolicy(GetAlertPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
GetAlertPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
AlertPolicy |
getAlertPolicy(String name)
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);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] |
Returns | |
---|---|
Type | Description |
AlertPolicy |
getAlertPolicyCallable()
public final 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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetAlertPolicyRequest,AlertPolicy> |
getSettings()
public final AlertPolicyServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
AlertPolicyServiceSettings |
getStub()
public AlertPolicyServiceStub getStub()
Returns | |
---|---|
Type | Description |
AlertPolicyServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listAlertPolicies(ResourceName name)
public final AlertPolicyServiceClient.ListAlertPoliciesPagedResponse listAlertPolicies(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);
}
}
Parameter | |
---|---|
Name | Description |
name |
com.google.api.resourcenames.ResourceName Required. The project 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 operation, instead. |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient.ListAlertPoliciesPagedResponse |
listAlertPolicies(ListAlertPoliciesRequest request)
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);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListAlertPoliciesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient.ListAlertPoliciesPagedResponse |
listAlertPolicies(OrganizationName name)
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);
}
}
Parameter | |
---|---|
Name | Description |
name |
OrganizationName Required. The project 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 operation, instead. |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient.ListAlertPoliciesPagedResponse |
listAlertPolicies(ProjectName name)
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);
}
}
Parameter | |
---|---|
Name | Description |
name |
ProjectName Required. The project 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 operation, instead. |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient.ListAlertPoliciesPagedResponse |
listAlertPolicies(String name)
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);
}
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The project 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 operation, instead. |
Returns | |
---|---|
Type | Description |
AlertPolicyServiceClient.ListAlertPoliciesPagedResponse |
listAlertPoliciesCallable()
public final 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;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAlertPoliciesRequest,ListAlertPoliciesResponse> |
listAlertPoliciesPagedCallable()
public final 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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAlertPoliciesRequest,ListAlertPoliciesPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateAlertPolicy(UpdateAlertPolicyRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
UpdateAlertPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
AlertPolicy |
updateAlertPolicy(FieldMask updateMask, AlertPolicy alertPolicy)
public final AlertPolicy updateAlertPolicy(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 | |
---|---|
Name | Description |
updateMask |
FieldMask 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 ( Examples of valid field masks include 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 |
alertPolicy |
AlertPolicy Required. The updated alerting policy or the updated values for the fields
listed in |
Returns | |
---|---|
Type | Description |
AlertPolicy |
updateAlertPolicyCallable()
public final UnaryCallable<UpdateAlertPolicyRequest,AlertPolicy> updateAlertPolicyCallable()
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();
ApiFuture<AlertPolicy> future =
alertPolicyServiceClient.updateAlertPolicyCallable().futureCall(request);
// Do something.
AlertPolicy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateAlertPolicyRequest,AlertPolicy> |