Reference documentation and code samples for the Stackdriver Monitoring V3 Client class CreateAlertPolicyRequest.
The protocol for the CreateAlertPolicy request.
Generated from protobuf message google.monitoring.v3.CreateAlertPolicyRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ 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 |
↳ alert_policy |
Google\Cloud\Monitoring\V3\AlertPolicy
Required. The requested alerting policy. You should omit the |
getName
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.
Generated from protobuf field string name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setName
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.
Generated from protobuf field string name = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAlertPolicy
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.
Generated from protobuf field .google.monitoring.v3.AlertPolicy alert_policy = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\AlertPolicy|null | |
hasAlertPolicy
clearAlertPolicy
setAlertPolicy
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.
Generated from protobuf field .google.monitoring.v3.AlertPolicy alert_policy = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\AlertPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this | |