Cloud Spanner V1 Client - Class ListDatabasesRequest (1.60.0)

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
NameDescription
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
TypeDescription
string

setParent

Required. The instance whose databases should be listed.

Values are of the form projects/<project>/instances/<instance>.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

If non-empty, page_token should contain a next_page_token from a previous ListDatabasesResponse.

Returns
TypeDescription
string

setPageToken

If non-empty, page_token should contain a next_page_token from a previous ListDatabasesResponse.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The instance whose databases should be listed. Values are of the form projects/<project>/instances/<instance>. Please see {@see \Google\Cloud\Spanner\Admin\Database\V1\DatabaseAdminClient::instanceName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\Spanner\Admin\Database\V1\ListDatabasesRequest