Google Cloud Filestore V1 Client - Class ListInstancesRequest (1.0.3)

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

ListInstancesRequest lists instances.

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

Methods

__construct

Constructor.

Parameters
NameDescription
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}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.

↳ page_size int

The maximum number of items to return.

↳ page_token string

The next_page_token value to use if there are additional results to retrieve for this list request.

↳ order_by string

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

↳ filter string

List filter.

getParent

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.

Returns
TypeDescription
string

setParent

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example us-west1-b. To retrieve instance information for all locations, use "-" for the {location} value.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The maximum number of items to return.

Returns
TypeDescription
int

setPageSize

The maximum number of items to return.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The next_page_token value to use if there are additional results to retrieve for this list request.

Returns
TypeDescription
string

setPageToken

The next_page_token value to use if there are additional results to retrieve for this list request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

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

Returns
TypeDescription
string

setOrderBy

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

List filter.

Returns
TypeDescription
string

setFilter

List filter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this