Google Cloud Chronicle V1 Client - Class RuleView (0.1.2)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class RuleView.

RuleView indicates the scope of fields to populate when returning the Rule resource.

Protobuf type google.cloud.chronicle.v1.RuleView

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

RULE_VIEW_UNSPECIFIED

Value: 0

The default/unset value.

The API will default to the BASIC view for ListRules/ListRuleRevisions. The API will default to the FULL view for GetRule.

Generated from protobuf enum RULE_VIEW_UNSPECIFIED = 0;

BASIC

Value: 1

Include basic metadata about the rule, but not the full contents.

Returned fields include: revision_id, revision_create_time, display_name, author, severity, type, allowed_run_frequency, near_real_time_live_rule_eligible, etag, and scope. This is the default value for ListRules and ListRuleRevisions.

Generated from protobuf enum BASIC = 1;

FULL

Value: 2

Include all fields.

This is the default value for GetRule.

Generated from protobuf enum FULL = 2;

REVISION_METADATA_ONLY

Value: 3

Include basic metadata about the rule's revision only.

Returned fields include: revision_id and revision_create_time.

Generated from protobuf enum REVISION_METADATA_ONLY = 3;