Google Cloud Memorystore V1 Client - Class ListInstancesRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Memorystore V1 Client class ListInstancesRequest.

Request message for ListInstances.

Generated from protobuf message google.cloud.memorystore.v1.ListInstancesRequest

Namespace

Google \ Cloud \ Memorystore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The parent to list instances from. Format: projects/{project}/locations/{location}
↳ page_size	int Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
↳ page_token	string Optional. A token identifying a page of results the server should return.
↳ filter	string Optional. Expression for filtering results.
↳ order_by	string Optional. Sort results by a defined order. Supported values: "name", "create_time".

getParent

Required. The parent to list instances from.

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

Returns
Type	Description
string

setParent

Required. The parent to list instances from.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
Type	Description
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A token identifying a page of results the server should return.

Returns
Type	Description
string

setPageToken

Optional. A token identifying a page of results the server should return.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. Expression for filtering results.

Returns
Type	Description
string

setFilter

Optional. Expression for filtering results.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

Optional. Sort results by a defined order. Supported values: "name", "create_time".

Returns
Type	Description
string

setOrderBy

Optional. Sort results by a defined order. Supported values: "name", "create_time".

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The parent to list instances from. Format: projects/{project}/locations/{location} Please see MemorystoreClient::locationName() for help formatting this field.

Returns
Type	Description
ListInstancesRequest