Google Cloud Parallelstore V1beta Client - Class ListInstancesRequest (0.4.0)

Version 0.4.0

• 0.7.1 (latest)
• 0.7.0
• 0.6.1
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Message for requesting list of Instances

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

Namespace

Google \ Cloud \ Parallelstore \ V1beta

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}. For Parallelstore locations map to Google Cloud zones, for example us-central1-a. To retrieve instance information for all locations, use "-" for the {location} value.
↳ 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. 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}.

For Parallelstore locations map to Google Cloud zones, for example us-central1-a. To retrieve instance information for all locations, use "-" for the {location} value.

Returns
Type	Description
string

setParent

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

For Parallelstore locations map to Google Cloud zones, for example us-central1-a. To retrieve instance information for all locations, use "-" for the {location} value.

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. 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}. For Parallelstore locations map to Google Cloud zones, for example us-central1-a. To retrieve instance information for all locations, use "-" for the {location} value. Please see Google\Cloud\Parallelstore\V1beta\ParallelstoreClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Parallelstore\V1beta\ListInstancesRequest