Reference documentation and code samples for the Cloud Spanner V1 Client class ListDatabasesRequest.
The request for ListDatabases.
Generated from protobuf message google.spanner.admin.database.v1.ListDatabasesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The instance whose databases should be listed. Values are of the form |
↳ page_size |
int
Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
↳ page_token |
string
If non-empty, |
getParent
Required. The instance whose databases should be listed.
Values are of the form projects/<project>/instances/<instance>.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The instance whose databases should be listed.
Values are of the form projects/<project>/instances/<instance>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
If non-empty, page_token should contain a
next_page_token from a
previous ListDatabasesResponse.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
If non-empty, page_token should contain a
next_page_token from a
previous ListDatabasesResponse.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The instance whose databases should be listed.
Values are of the form |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\ListDatabasesRequest | |