Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ListDatabasesRequest.
Message for requesting list of Databases.
Generated from protobuf message google.cloud.alloydb.v1.ListDatabasesRequest
Namespace
Google \ Cloud \ AlloyDb \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Parent value for ListDatabasesRequest. |
↳ page_size |
int
Optional. The maximum number of databases to return. The service may return fewer than this value. If unspecified, 2000 is the default page_size. The max value of page_size will be 4000, values above max will be coerced to max. |
↳ page_token |
string
Optional. A page token, received from a previous |
↳ filter |
string
Optional. Filtering results. This field is currently not supported, its value will be ignored if passed. |
getParent
Required. Parent value for ListDatabasesRequest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Parent value for ListDatabasesRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of databases to return. The service may return fewer than this value. If unspecified, 2000 is the default page_size. The max value of page_size will be 4000, values above max will be coerced to max.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of databases to return. The service may return fewer than this value. If unspecified, 2000 is the default page_size. The max value of page_size will be 4000, values above max will be coerced to max.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous ListDatabases call.
This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous ListDatabases call.
This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filtering results.
This field is currently not supported, its value will be ignored if passed.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filtering results.
This field is currently not supported, its value will be ignored if passed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Parent value for ListDatabasesRequest. Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::clusterName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AlloyDb\V1\ListDatabasesRequest |
|