Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1beta Client class ListInstancesRequest.
Message for requesting list of Instances
Generated from protobuf message google.cloud.alloydb.v1beta.ListInstancesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/- |
↳ 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
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 name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:
- projects/{project}/locations/-/clusters/-
- projects/{project}/locations/{region}/clusters/-
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:
- projects/{project}/locations/-/clusters/-
- projects/{project}/locations/{region}/clusters/-
| 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
A token identifying a page of results the server should return.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
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 | |