Google Cloud Chronicle V1 Client - Class GetReferenceListRequest (0.1.2)

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

A request to get details about a reference list.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the reference list to retrieve. Format: projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}
↳ view int

How much of the ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_FULL.

getName

Required. The resource name of the reference list to retrieve.

Format: projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}

Returns
Type Description
string

setName

Required. The resource name of the reference list to retrieve.

Format: projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}

Parameter
Name Description
var string
Returns
Type Description
$this

getView

How much of the ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_FULL.

Returns
Type Description
int

setView

How much of the ReferenceList to view. Defaults to REFERENCE_LIST_VIEW_FULL.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the reference list to retrieve. Format: projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list} Please see ReferenceListServiceClient::referenceListName() for help formatting this field.
Returns
Type Description
GetReferenceListRequest