Google Cloud Chronicle V1 Client - Class ListReferenceListsRequest (0.1.2)

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

A request for a list of reference lists.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent, which owns this collection of reference lists. Format: projects/{project}/locations/{location}/instances/{instance}

↳ page_size int

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

↳ page_token string

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

↳ view int

How much of each ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_BASIC.

getParent

Required. The parent, which owns this collection of reference lists.

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

Returns
Type Description
string

setParent

Required. The parent, which owns this collection of reference lists.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of reference lists to return.

The service may return fewer than this value. If unspecified, at most 100 reference lists 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 reference lists to return.

The service may return fewer than this value. If unspecified, at most 100 reference lists 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

A page token, received from a previous ListReferenceLists call.

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

Returns
Type Description
string

setPageToken

A page token, received from a previous ListReferenceLists call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getView

How much of each ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_BASIC.

Returns
Type Description
int

setView

How much of each ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_BASIC.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which owns this collection of reference lists. Format: projects/{project}/locations/{location}/instances/{instance} Please see ReferenceListServiceClient::instanceName() for help formatting this field.

Returns
Type Description
ListReferenceListsRequest