Reference documentation and code samples for the Google Cloud Chronicle V1 Client class RuleDeployment.
The RuleDeployment resource represents the deployment state of a Rule.
Generated from protobuf message google.cloud.chronicle.v1.RuleDeployment
Namespace
Google \ Cloud \ Chronicle \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
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
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
int
The run frequency of the rule deployment.
↳ execution_state
int
Output only. The execution state of the rule deployment.
↳ producer_rules
array
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
array
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
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.
getName
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
string
setName
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
var
string
$this
getEnabled
Whether the rule is currently deployed continuously against incoming data.
bool
setEnabled
Whether the rule is currently deployed continuously against incoming data.
var
bool
$this
getAlerting
Whether detections resulting from this deployment should be considered alerts.
bool
setAlerting
Whether detections resulting from this deployment should be considered alerts.
var
bool
$this
getArchived
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.
bool
setArchived
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.
var
bool
$this
getArchiveTime
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.
hasArchiveTime
clearArchiveTime
setArchiveTime
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.
$this
getRunFrequency
The run frequency of the rule deployment.
int
setRunFrequency
The run frequency of the rule deployment.
var
int
$this
getExecutionState
Output only. The execution state of the rule deployment.
int
setExecutionState
Output only. The execution state of the rule deployment.
var
int
$this
getProducerRules
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}
setProducerRules
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}
var
string[]
$this
getConsumerRules
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}
setConsumerRules
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}
var
string[]
$this
getLastAlertStatusChangeTime
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.
hasLastAlertStatusChangeTime
clearLastAlertStatusChangeTime
setLastAlertStatusChangeTime
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.
$this
