Chronicle V1 API - Class Google::Cloud::Chronicle::V1::RuleDeployment (v0.3.1)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::RuleDeployment.

The RuleDeployment resource represents the deployment state of a Rule.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#alerting

def alerting() -> ::Boolean
Returns
  • (::Boolean) — Whether detections resulting from this deployment should be considered alerts.

#alerting=

def alerting=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether detections resulting from this deployment should be considered alerts.
Returns
  • (::Boolean) — Whether detections resulting from this deployment should be considered alerts.

#archive_time

def archive_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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.

#archived

def archived() -> ::Boolean
Returns
  • (::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.

#archived=

def archived=(value) -> ::Boolean
Parameter
  • value (::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.
Returns
  • (::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.

#consumer_rules

def consumer_rules() -> ::Array<::String>
Returns
  • (::Array<::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}

#enabled

def enabled() -> ::Boolean
Returns
  • (::Boolean) — Whether the rule is currently deployed continuously against incoming data.

#enabled=

def enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the rule is currently deployed continuously against incoming data.
Returns
  • (::Boolean) — Whether the rule is currently deployed continuously against incoming data.

#execution_state

def execution_state() -> ::Google::Cloud::Chronicle::V1::RuleDeployment::ExecutionState
Returns

#last_alert_status_change_time

def last_alert_status_change_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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

#name=

def name=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#producer_rules

def producer_rules() -> ::Array<::String>
Returns
  • (::Array<::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}

#run_frequency

def run_frequency() -> ::Google::Cloud::Chronicle::V1::RunFrequency
Returns

#run_frequency=

def run_frequency=(value) -> ::Google::Cloud::Chronicle::V1::RunFrequency
Parameter
Returns