Stackdriver Monitoring V3 Client - Class AlertPolicy (1.4.0)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class AlertPolicy.

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. For an overview of alert policies, see Introduction to Alerting.

Generated from protobuf message google.monitoring.v3.AlertPolicy

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

↳ display_name string

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

↳ documentation Google\Cloud\Monitoring\V3\AlertPolicy\Documentation

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

↳ user_labels array|Google\Protobuf\Internal\MapField

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

↳ conditions array<Google\Cloud\Monitoring\V3\AlertPolicy\Condition>

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition.

↳ combiner int

How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

↳ enabled Google\Protobuf\BoolValue

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

↳ validity Google\Rpc\Status

Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.

↳ notification_channels array

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the [ListNotificationChannels] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

↳ creation_record Google\Cloud\Monitoring\V3\MutationRecord

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

↳ mutation_record Google\Cloud\Monitoring\V3\MutationRecord

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

↳ alert_strategy Google\Cloud\Monitoring\V3\AlertPolicy\AlertStrategy

Control over how this alert policy's notification channels are notified.

getName

Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

Returns
TypeDescription
string

setName

Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

Returns
TypeDescription
string

setDisplayName

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDocumentation

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\AlertPolicy\Documentation|null

hasDocumentation

clearDocumentation

setDocumentation

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\AlertPolicy\Documentation
Returns
TypeDescription
$this

getUserLabels

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setUserLabels

User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getConditions

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions.

If condition_time_series_query_language is present, it must be the only condition.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setConditions

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions.

If condition_time_series_query_language is present, it must be the only condition.

Parameter
NameDescription
var array<Google\Cloud\Monitoring\V3\AlertPolicy\Condition>
Returns
TypeDescription
$this

getCombiner

How to combine the results of multiple conditions to determine if an incident should be opened.

If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

Returns
TypeDescription
int

setCombiner

How to combine the results of multiple conditions to determine if an incident should be opened.

If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEnabled

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

Returns
TypeDescription
Google\Protobuf\BoolValue|null

hasEnabled

clearEnabled

getEnabledValue

Returns the unboxed value from getEnabled()

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

Returns
TypeDescription
bool|null

setEnabled

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

Parameter
NameDescription
var Google\Protobuf\BoolValue
Returns
TypeDescription
$this

setEnabledValue

Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

Parameter
NameDescription
var bool|null
Returns
TypeDescription
$this

getValidity

Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.

Returns
TypeDescription
Google\Rpc\Status|null

hasValidity

clearValidity

setValidity

Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getNotificationChannels

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the [ListNotificationChannels] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNotificationChannels

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the [ListNotificationChannels] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCreationRecord

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\MutationRecord|null

hasCreationRecord

clearCreationRecord

setCreationRecord

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\MutationRecord
Returns
TypeDescription
$this

getMutationRecord

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\MutationRecord|null

hasMutationRecord

clearMutationRecord

setMutationRecord

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\MutationRecord
Returns
TypeDescription
$this

getAlertStrategy

Control over how this alert policy's notification channels are notified.

Returns
TypeDescription
Google\Cloud\Monitoring\V3\AlertPolicy\AlertStrategy|null

hasAlertStrategy

clearAlertStrategy

setAlertStrategy

Control over how this alert policy's notification channels are notified.

Parameter
NameDescription
var Google\Cloud\Monitoring\V3\AlertPolicy\AlertStrategy
Returns
TypeDescription
$this