Reference documentation and code samples for the Google Cloud Lustre V1 Client class ListInstancesRequest.
Message for requesting list of Instances
Generated from protobuf messagegoogle.cloud.lustre.v1.ListInstancesRequest
Namespace
Google \ Cloud \ Lustre \ 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 a list of instances, in the formatprojects/{projectId}/locations/{location}. To retrieve instance information for all locations, use "-" as the value of{location}.
↳ page_size
int
Optional. Requested page size. Server might 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. Desired order of results.
getParent
Required. The project and location for which to retrieve a list of
instances, in the formatprojects/{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 formatprojects/{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
string
Required. The project and location for which to retrieve a list of
instances, in the formatprojects/{projectId}/locations/{location}.
To retrieve instance information for all locations, use "-" as the value
of{location}. Please seeLustreClient::locationName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Lustre V1 Client - Class ListInstancesRequest (0.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.2.0 (latest)](/php/docs/reference/cloud-lustre/latest/V1.ListInstancesRequest)\n- [0.1.1](/php/docs/reference/cloud-lustre/0.1.1/V1.ListInstancesRequest) \nReference documentation and code samples for the Google Cloud Lustre V1 Client class ListInstancesRequest.\n\nMessage for requesting list of Instances\n\nGenerated from protobuf message `google.cloud.lustre.v1.ListInstancesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Lustre \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The project and location for which to retrieve a list of\ninstances, in the format `projects/{projectId}/locations/{location}`.\n\nTo retrieve instance information for all locations, use \"-\" as the value\nof `{location}`.\n\n### setParent\n\nRequired. The project and location for which to retrieve a list of\ninstances, in the format `projects/{projectId}/locations/{location}`.\n\nTo retrieve instance information for all locations, use \"-\" as the value\nof `{location}`.\n\n### getPageSize\n\nOptional. Requested page size. Server might return fewer items than\nrequested. If unspecified, the server will pick an appropriate default.\n\n### setPageSize\n\nOptional. Requested page size. Server might return fewer items than\nrequested. If unspecified, the server will pick an appropriate default.\n\n### getPageToken\n\nOptional. A token identifying a page of results the server should return.\n\n### setPageToken\n\nOptional. A token identifying a page of results the server should return.\n\n### getFilter\n\nOptional. Filtering results.\n\n### setFilter\n\nOptional. Filtering results.\n\n### getOrderBy\n\nOptional. Desired order of results.\n\n### setOrderBy\n\nOptional. Desired order of results.\n\n### static::build"]]
