Interface AlertPolicyServiceGrpc.AsyncService (3.34.0)

public static interface AlertPolicyServiceGrpc.AsyncService

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.

Methods

createAlertPolicy(CreateAlertPolicyRequest request, StreamObserver<AlertPolicy> responseObserver)

public default void createAlertPolicy(CreateAlertPolicyRequest request, StreamObserver<AlertPolicy> responseObserver)

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.

Parameters
NameDescription
requestCreateAlertPolicyRequest
responseObserverio.grpc.stub.StreamObserver<AlertPolicy>

deleteAlertPolicy(DeleteAlertPolicyRequest request, StreamObserver<Empty> responseObserver)

public default void deleteAlertPolicy(DeleteAlertPolicyRequest request, StreamObserver<Empty> responseObserver)

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.

Parameters
NameDescription
requestDeleteAlertPolicyRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getAlertPolicy(GetAlertPolicyRequest request, StreamObserver<AlertPolicy> responseObserver)

public default void getAlertPolicy(GetAlertPolicyRequest request, StreamObserver<AlertPolicy> responseObserver)

Gets a single alerting policy.

Parameters
NameDescription
requestGetAlertPolicyRequest
responseObserverio.grpc.stub.StreamObserver<AlertPolicy>

listAlertPolicies(ListAlertPoliciesRequest request, StreamObserver<ListAlertPoliciesResponse> responseObserver)

public default void listAlertPolicies(ListAlertPoliciesRequest request, StreamObserver<ListAlertPoliciesResponse> responseObserver)

Lists the existing alerting policies for the workspace.

Parameters
NameDescription
requestListAlertPoliciesRequest
responseObserverio.grpc.stub.StreamObserver<ListAlertPoliciesResponse>

updateAlertPolicy(UpdateAlertPolicyRequest request, StreamObserver<AlertPolicy> responseObserver)

public default void updateAlertPolicy(UpdateAlertPolicyRequest request, StreamObserver<AlertPolicy> responseObserver)

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.

Parameters
NameDescription
requestUpdateAlertPolicyRequest
responseObserverio.grpc.stub.StreamObserver<AlertPolicy>