RuleDeployment

The RuleDeployment resource represents the deployment state of a Rule.

JSON representation 
{
  "name": string,
  "enabled": boolean,
  "alerting": boolean,
  "archived": boolean,
  "archive_time": string,
  "run_frequency": enum (RunFrequency),
  "execution_state": enum (ExecutionState)
  "last_alert_status_change_time": string
}
Fields
name

string

Required. The resource name of the rule deployment. Note that RuleDeployment is a child of the overall Rule, not any individual revision, so the resource ID segment for the Rule resource must not reference a specific revision. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment
enabled

boolean

Whether the rule is currently deployed continuously against incoming data.
alerting

boolean

Whether detections resulting from this deployment should be considered alerts.
archived

boolean

The archive state of the rule deployment. Cannot be set to true unless enabled is set to false. If set to true, alerting will automatically be set to false. If currently set to true, enabled, alerting, and run_frequency cannot be updated.
archive_time

string (Timestamp format)

Output only. The timestamp when the rule deployment archive state was last set to true. If the rule deployment's current archive state is not set to true, the field will be empty.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
run_frequency

enum (RunFrequency)

The run frequency of the rule deployment.
execution_state

enum (ExecutionState)

Output only. The execution state of the rule deployment.
last_alert_status_change_time

string (Timestamp format)

Output only. The timestamp when the rule deployment alert state was last changed. This field is filled regardless of the current alert state. For example, if the current alert status is false, this timestamp is the timestamp when the alert status was changed to false.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ExecutionState

The possible execution states that the rule deployment can be in.

Enums
EXECUTION_STATE_UNSPECIFIED Unspecified or unknown execution state.
DEFAULT Default execution state.
LIMITED Rules in limited state may not have their executions guaranteed.
PAUSED Paused rules are not executed at all.