Reference documentation and code samples for the Google Cloud Lustre V1 Client class ListInstancesRequest.
Message for requesting list of Instances
Generated from protobuf message google.cloud.lustre.v1.ListInstancesRequest
Namespace
Google \ Cloud \ Lustre \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ parent | stringRequired. The project and location for which to retrieve a list of instances, in the format |
↳ page_size | intOptional. Requested page size. Server might return fewer items than requested. If unspecified, the server will pick an appropriate default. |
↳ page_token | stringOptional. A token identifying a page of results the server should return. |
↳ filter | stringOptional. Filtering results. |
↳ order_by | stringOptional. Desired order of results. |
getParent
Required. The project and location for which to retrieve a list of instances, in the format projects/{projectId}/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 a list of instances, in the format projects/{projectId}/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 might return fewer items than requested. If unspecified, the server will pick an appropriate default.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Requested page size. Server might 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. Desired order of results.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
Optional. Desired order of results.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent | stringRequired. The project and location for which to retrieve a list of instances, in the format To retrieve instance information for all locations, use "-" as the value of |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest | |