RuleDeployment(mapping=None, *, ignore_unknown_fields=False, **kwargs)The RuleDeployment resource represents the deployment state of a Rule.
Attributes |
|
|---|---|
| Name | Description |
name |
str
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 |
bool
Whether the rule is currently deployed continuously against incoming data. |
alerting |
bool
Whether detections resulting from this deployment should be considered alerts. |
archived |
bool
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 |
google.protobuf.timestamp_pb2.Timestamp
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. |
run_frequency |
google.cloud.chronicle_v1.types.RunFrequency
The run frequency of the rule deployment. |
execution_state |
google.cloud.chronicle_v1.types.RuleDeployment.ExecutionState
Output only. The execution state of the rule deployment. |
producer_rules |
MutableSequence[str]
Output only. The names of the associated/chained producer rules. Rules are considered producers for this rule if this rule explicitly filters on their ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
|
consumer_rules |
MutableSequence[str]
Output only. The names of the associated/chained consumer rules. Rules are considered consumers of this rule if their rule text explicitly filters on this rule's ruleid. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}
|
last_alert_status_change_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The timestamp when the rule deployment alert state was lastly changed. This is filled regardless of the current alert state. E.g. if the current alert status is false, this timestamp will be the timestamp when the alert status was changed to false. |
Classes
ExecutionState
ExecutionState(value)The possible execution states the rule deployment can be in.