Google Cloud AlloyDB for PostgreSQL V1alpha Client - Class ListDatabasesRequest (0.9.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha Client class ListDatabasesRequest.

Message for requesting list of Databases.

Generated from protobuf message google.cloud.alloydb.v1alpha.ListDatabasesRequest

Namespace

Google \ Cloud \ AlloyDb \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
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, an appropriate number of databases will be returned. The max value will be 2000, values above max will be coerced to max.

↳ page_token string

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.

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

setParent

Required. Parent value for ListDatabasesRequest.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The maximum number of databases to return. The service may return fewer than this value. If unspecified, an appropriate number of databases will be returned. The max value will be 2000, values above max will be coerced to max.

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of databases to return. The service may return fewer than this value. If unspecified, an appropriate number of databases will be returned. The max value will be 2000, values above max will be coerced to max.

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

getFilter

Optional. Filtering results.

This field is currently not supported, its value will be ignored if passed.

Returns
TypeDescription
string

setFilter

Optional. Filtering results.

This field is currently not supported, its value will be ignored if passed.

Parameter
NameDescription
var string
Returns
TypeDescription
$this