Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::CreateAlertPolicyRequest (v0.16.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::CreateAlertPolicyRequest.

The protocol for the CreateAlertPolicy request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#alert_policy

def alert_policy() -> ::Google::Cloud::Monitoring::V3::AlertPolicy
Returns
  • (::Google::Cloud::Monitoring::V3::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.

#alert_policy=

def alert_policy=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy
Parameter
  • value (::Google::Cloud::Monitoring::V3::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.
Returns
  • (::Google::Cloud::Monitoring::V3::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.

#name

def name() -> ::String
Returns
  • (::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 /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.

#name=

def name=(value) -> ::String
Parameter
  • value (::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 /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.

Returns
  • (::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 /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.