Google Cloud Chronicle V1 Client - Class ListRuleExecutionErrorsRequest (0.5.0)

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

Request message for ListRuleExecutionErrors.

Generated from protobuf message google.cloud.chronicle.v1.ListRuleExecutionErrorsRequest

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The instance to list rule execution errors from. Format: projects/{project}/locations/{location}/instances/{instance}
↳ page_size int

The maximum number of rule execution errors to return. The service may return fewer than this value. If unspecified, at most 1000 rule execution errors will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
↳ page_token string

A page token, received from a previous ListRuleExecutionErrors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleExecutionErrors must match the call that provided the page token.
↳ filter string

A filter that can be used to retrieve specific rule execution errors. Only the following filters are allowed: rule = "{Rule.name}" curated_rule = "{CuratedRule.name}" The value for rule or curated_rule must be a valid rule resource name or a valid curated rule resource name specified in quotes. For 'rule', an optional 'revision_id' can be specified which can be used to fetch errors for a given revision of the rule. A '-' is also allowed to fetch errors across all revisions of the rule. If unspecified, only errors corresponding to the most recent revision of the rule will be returned. So these variations are all allowed: rule = "{Rule.name}" rule = "{Rule.name}\@{Rule.revision_id}" rule = "{Rule.name}\@-" Revision IDs are not supported for curated rules.

getParent

Required. The instance to list rule execution errors from.

Format: projects/{project}/locations/{location}/instances/{instance}

Returns
Type Description
string

setParent

Required. The instance to list rule execution errors from.

Format: projects/{project}/locations/{location}/instances/{instance}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of rule execution errors to return. The service may return fewer than this value. If unspecified, at most 1000 rule execution errors will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

Returns
Type Description
int

setPageSize

The maximum number of rule execution errors to return. The service may return fewer than this value. If unspecified, at most 1000 rule execution errors will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListRuleExecutionErrors call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleExecutionErrors must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListRuleExecutionErrors call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleExecutionErrors must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

A filter that can be used to retrieve specific rule execution errors.

Only the following filters are allowed:

  rule = "{Rule.name}"
  curated_rule = "{CuratedRule.name}"

The value for rule or curated_rule must be a valid rule resource name or a valid curated rule resource name specified in quotes. For 'rule', an optional 'revision_id' can be specified which can be used to fetch errors for a given revision of the rule. A '-' is also allowed to fetch errors across all revisions of the rule. If unspecified, only errors corresponding to the most recent revision of the rule will be returned. So these variations are all allowed:

  rule = "{Rule.name}"
  rule = "{Rule.name}\@{Rule.revision_id}"
  rule = "{Rule.name}\@-"

Revision IDs are not supported for curated rules.

Returns
Type Description
string

setFilter

A filter that can be used to retrieve specific rule execution errors.

Only the following filters are allowed:

  rule = "{Rule.name}"
  curated_rule = "{CuratedRule.name}"

The value for rule or curated_rule must be a valid rule resource name or a valid curated rule resource name specified in quotes. For 'rule', an optional 'revision_id' can be specified which can be used to fetch errors for a given revision of the rule. A '-' is also allowed to fetch errors across all revisions of the rule. If unspecified, only errors corresponding to the most recent revision of the rule will be returned. So these variations are all allowed:

  rule = "{Rule.name}"
  rule = "{Rule.name}\@{Rule.revision_id}"
  rule = "{Rule.name}\@-"

Revision IDs are not supported for curated rules.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The instance to list rule execution errors from. Format: projects/{project}/locations/{location}/instances/{instance} Please see RuleExecutionErrorServiceClient::instanceName() for help formatting this field.
Returns
Type Description
ListRuleExecutionErrorsRequest