Memorystore for Memcached V1 Client - Class ListInstancesRequest (1.3.4)

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

Request for ListInstances.

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

Namespace

Google \ Cloud \ Memcache \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region
↳ page_size int

The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
↳ page_token string

The next_page_token value returned from a previous List request, if any.
↳ filter string

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".
↳ order_by string

Sort results. Supported values are "name", "name desc" or "" (unsorted).

getParent

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

Returns
Type Description
string

setParent

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

Returns
Type Description
int

setPageSize

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The next_page_token value returned from a previous List request, if any.

Returns
Type Description
string

setPageToken

The next_page_token value returned from a previous List request, if any.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

Returns
Type Description
string

setFilter

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Sort results. Supported values are "name", "name desc" or "" (unsorted).

Returns
Type Description
string

setOrderBy

Sort results. Supported values are "name", "name desc" or "" (unsorted).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region Please see Google\Cloud\Memcache\V1\CloudMemcacheClient::locationName() for help formatting this field.
Returns
Type Description
Google\Cloud\Memcache\V1\ListInstancesRequest