Cloud Spanner V1 Client - Class ListDatabasesRequest (1.76.0)

Version latest

• 1.76.0 (latest)
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

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 projects/<project>/instances/<instance>.
↳ 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, page_token should contain a next_page_token from a previous ListDatabasesResponse.

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 projects/<project>/instances/<instance>. Please see Google\Cloud\Spanner\Admin\Database\V1\DatabaseAdminClient::instanceName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Spanner\Admin\Database\V1\ListDatabasesRequest