Google Cloud Parallelstore V1 Client - Class ListInstancesRequest (0.7.0)

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

List instances request.

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

Namespace

Google \ Cloud \ Parallelstore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. To retrieve instance information for all locations, use "-" as the value of `{location}`.
`↳ page_size`	`int` Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
`↳ page_token`	`string` Optional. A token identifying a page of results the server should return.
`↳ filter`	`string` Optional. Filtering results.
`↳ order_by`	`string` Optional. Hint for how to order the results.

getParent

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}.

Returns
Type	Description
`string`

setParent

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

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

Returns
Type	Description
`int`

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, the 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. Filtering results.

Returns
Type	Description
`string`

setFilter

Optional. Filtering results.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. Hint for how to order the results.

Returns
Type	Description
`string`

setOrderBy

Optional. Hint for how to order the results.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

parent

string

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}. Please see Google\Cloud\Parallelstore\V1\ParallelstoreClient::locationName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Parallelstore\V1\ListInstancesRequest`