RuleDeploymentState class

Input properties used for looking up and filtering RuleDeployment resources.

Constructors

RuleDeploymentState({Input<bool?>? alerting, Input<String?>? archiveTime, Input<bool?>? archived, Input<List<String>?>? consumerRules, Input<bool?>? enabled, Input<String?>? executionState, Input<String?>? instance, Input<String?>? lastAlertStatusChangeTime, Input<String?>? location, Input<String?>? name, Input<List<String>?>? producerRules, Input<String?>? project, Input<String?>? rule, Input<String?>? runFrequency, Input<RuleDeploymentScheduleCustomizations?>? scheduleCustomizations})
Creates a new RuleDeploymentState. alerting Whether detections resulting from this deployment should be considered archiveTime 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. archived The archive state of the rule deployment. consumerRules Output only. The names of the associated/chained consumer rules. Rules are considered enabled Whether the rule is currently deployed continuously against incoming data. executionState The execution state of the rule deployment. instance The unique identifier for the Chronicle instance, which is the same as the customer ID. lastAlertStatusChangeTime 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. location The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". name The resource name of the rule deployment. producerRules Output only. The names of the associated/chained producer rules. Rules are considered project The ID of the project in which the resource belongs. rule The Rule ID of the rule. runFrequency The run frequency of the rule deployment. scheduleCustomizations The schedule customizations of the rule deployment. Only valid for
const
RuleDeploymentState.fromMap(Map<String, dynamic> map)
factory

Properties

alerting → Input<bool?>?
Whether detections resulting from this deployment should be considered alerts.
final
archived → Input<bool?>?
The archive state of the rule deployment. Cannot be set to true unless enabled is set to false i.e. archiving requires a two-step process: first, disable the rule by setting 'enabled' to false, then set 'archive' to true. If set to true, alerting will automatically be set to false. If currently set to true, enabled, alerting, and runFrequency cannot be updated.
final
archiveTime → Input<String?>?
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.
final
consumerRules → Input<List<String>?>?
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}
final
enabled → Input<bool?>?
Whether the rule is currently deployed continuously against incoming data.
final
executionState → Input<String?>?
The execution state of the rule deployment. Possible values: DEFAULT LIMITED PAUSED
final
hashCode → int
The hash code for this object.
no setterinherited
instance → Input<String?>?
The unique identifier for the Chronicle instance, which is the same as the customer ID.
final
lastAlertStatusChangeTime → Input<String?>?
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.
final
location → Input<String?>?
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
final
name → Input<String?>?
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
final
producerRules → Input<List<String>?>?
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}
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
rule → Input<String?>?
The Rule ID of the rule.
final
runFrequency → Input<String?>?
The run frequency of the rule deployment. Possible values: LIVE HOURLY DAILY LIVE_CUSTOMIZABLE HOURLY_CUSTOMIZABLE Note: Certain legacy run frequencies are deprecated. For multi-event rules, use LIVE_CUSTOMIZABLE or HOURLY_CUSTOMIZABLE (for match windows <=2d), or DAILY (for match windows >2d). Legacy values LIVE and HOURLY are mapped to their customizable counterparts on the backend. DAILY for <=2d match window multi-event rules will be happed to HOURLY_CUSTOMIZABLE. For single-event rules, HOURLY and DAILY are deprecated and mapped to LIVE. If you continue to use deprecated values in your Terraform configuration, Terraform will silently suppress the diff and ignore the changes to prevent infinite update loops.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduleCustomizations → Input<RuleDeploymentScheduleCustomizations?>?
The schedule customizations of the rule deployment. Only valid for customizable run frequencies. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited