Google Cloud Chronicle V1 Client - Class ListRuleRevisionsRequest (0.1.2)

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

Request message for ListRuleRevisions method.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the rule to list revisions for. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}

↳ page_size int

The maximum number of revisions to return per page. The service may return fewer than this value. If unspecified, at most 100 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

The page token, received from a previous ListRuleRevisions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRuleRevisions must match the call that provided the page token.

↳ view int

The view field indicates the scope of fields to populate for the revision being returned. If unspecified, defaults to BASIC.

getName

Required. The name of the rule to list revisions for.

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

Returns
Type Description
string

setName

Required. The name of the rule to list revisions for.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of revisions to return per page. The service may return fewer than this value. If unspecified, at most 100 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

The maximum number of revisions to return per page. The service may return fewer than this value. If unspecified, at most 100 revisions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The page token, received from a previous ListRuleRevisions call.

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

Returns
Type Description
string

setPageToken

The page token, received from a previous ListRuleRevisions call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getView

The view field indicates the scope of fields to populate for the revision being returned. If unspecified, defaults to BASIC.

Returns
Type Description
int

setView

The view field indicates the scope of fields to populate for the revision being returned. If unspecified, defaults to BASIC.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the rule to list revisions for. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule} Please see RuleServiceClient::ruleName() for help formatting this field.

Returns
Type Description
ListRuleRevisionsRequest