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

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

The properties of a PluggableDatabase.

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

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ compartment_id string

Required. The OCID of the compartment.

↳ connection_strings PluggableDatabaseConnectionStrings

Optional. The Connection strings used to connect to the Oracle Database.

↳ container_database_ocid string

Required. The OCID of the CDB.

↳ defined_tags array|Google\Protobuf\Internal\MapField

Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.

↳ freeform_tags array|Google\Protobuf\Internal\MapField

Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

↳ ocid string

Output only. The OCID of the pluggable database.

↳ is_restricted bool

Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

↳ lifecycle_details string

Output only. Additional information about the current lifecycle state.

↳ lifecycle_state int

Output only. The current state of the pluggable database.

↳ pdb_name string

Required. The database name.

↳ pdb_node_level_details array<PluggableDatabaseNodeLevelDetails>

Optional. Pluggable Database Node Level Details

↳ database_management_config DatabaseManagementConfig

Output only. The configuration of the Database Management service.

↳ operations_insights_state int

Output only. The status of Operations Insights for this Database.

getCompartmentId

Required. The OCID of the compartment.

Returns
Type Description
string

setCompartmentId

Required. The OCID of the compartment.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectionStrings

Optional. The Connection strings used to connect to the Oracle Database.

Returns
Type Description
PluggableDatabaseConnectionStrings|null

hasConnectionStrings

clearConnectionStrings

setConnectionStrings

Optional. The Connection strings used to connect to the Oracle Database.

Parameter
Name Description
var PluggableDatabaseConnectionStrings
Returns
Type Description
$this

getContainerDatabaseOcid

Required. The OCID of the CDB.

Returns
Type Description
string

setContainerDatabaseOcid

Required. The OCID of the CDB.

Parameter
Name Description
var string
Returns
Type Description
$this

getDefinedTags

Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.

Returns
Type Description
Google\Protobuf\Internal\MapField

setDefinedTags

Optional. Defined tags for this resource. Each key is predefined and scoped to a namespace.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getFreeformTags

Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

Returns
Type Description
Google\Protobuf\Internal\MapField

setFreeformTags

Optional. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getOcid

Output only. The OCID of the pluggable database.

Returns
Type Description
string

setOcid

Output only. The OCID of the pluggable database.

Parameter
Name Description
var string
Returns
Type Description
$this

getIsRestricted

Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

Returns
Type Description
bool

setIsRestricted

Optional. The restricted mode of the pluggable database. If a pluggable database is opened in restricted mode, the user needs both create a session and have restricted session privileges to connect to it.

Parameter
Name Description
var bool
Returns
Type Description
$this

getLifecycleDetails

Output only. Additional information about the current lifecycle state.

Returns
Type Description
string

setLifecycleDetails

Output only. Additional information about the current lifecycle state.

Parameter
Name Description
var string
Returns
Type Description
$this

getLifecycleState

Output only. The current state of the pluggable database.

Returns
Type Description
int Enum of type PluggableDatabaseLifecycleState.

setLifecycleState

Output only. The current state of the pluggable database.

Parameter
Name Description
var int

Enum of type PluggableDatabaseLifecycleState.

Returns
Type Description
$this

getPdbName

Required. The database name.

Returns
Type Description
string

setPdbName

Required. The database name.

Parameter
Name Description
var string
Returns
Type Description
$this

getPdbNodeLevelDetails

Optional. Pluggable Database Node Level Details

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPdbNodeLevelDetails

Optional. Pluggable Database Node Level Details

Parameter
Name Description
var array<PluggableDatabaseNodeLevelDetails>
Returns
Type Description
$this

getDatabaseManagementConfig

Output only. The configuration of the Database Management service.

Returns
Type Description
DatabaseManagementConfig|null

hasDatabaseManagementConfig

clearDatabaseManagementConfig

setDatabaseManagementConfig

Output only. The configuration of the Database Management service.

Parameter
Name Description
var DatabaseManagementConfig
Returns
Type Description
$this

getOperationsInsightsState

Output only. The status of Operations Insights for this Database.

Returns
Type Description
int Enum of type OperationsInsightsState.

setOperationsInsightsState

Output only. The status of Operations Insights for this Database.

Parameter
Name Description
var int

Enum of type OperationsInsightsState.

Returns
Type Description
$this