Google Cloud Oracle Database V1 Client - Class ListDatabasesRequest (0.8.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class ListDatabasesRequest.

The request for Database.List.

Generated from protobuf message google.cloud.oracledatabase.v1.ListDatabasesRequest

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource name in the following format: projects/{project}/locations/{region}

↳ page_size int

Optional. The maximum number of items to return. If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.

↳ page_token string

Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.

↳ filter string

Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"

getParent

Required. The parent resource name in the following format: projects/{project}/locations/{region}

Returns
Type Description
string

setParent

Required. The parent resource name in the following format: projects/{project}/locations/{region}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of items to return.

If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of items to return.

If unspecified, a maximum of 50 Databases will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.

Returns
Type Description
string

setPageToken

Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"

Returns
Type Description
string

setFilter

Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource name in the following format: projects/{project}/locations/{region} Please see OracleDatabaseClient::locationName() for help formatting this field.

Returns
Type Description
ListDatabasesRequest