Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class Database.
Details of the Database resource.
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/
Generated from protobuf message google.cloud.oracledatabase.v1.Database
Namespace
Google \ Cloud \ OracleDatabase \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database} |
↳ db_name |
string
Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted. |
↳ db_unique_name |
string
Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up. |
↳ admin_password |
string
Optional. The password for the default ADMIN user. Note: Only one of |
↳ admin_password_secret_version |
string
Optional. The resource name of a secret version in Secret Manager which contains the database admin user's password. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of |
↳ tde_wallet_password |
string
Optional. The TDE wallet password for the database. Note: Only one of |
↳ tde_wallet_password_secret_version |
string
Optional. The resource name of a secret version in Secret Manager which contains the TDE wallet password for the database. Format: projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of |
↳ character_set |
string
Optional. The character set for the database. The default is AL32UTF8. |
↳ ncharacter_set |
string
Optional. The national character set for the database. The default is AL16UTF16. |
↳ oci_url |
string
Output only. HTTPS link to OCI resources exposed to Customer via UI Interface. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The date and time that the Database was created. |
↳ properties |
DatabaseProperties
Optional. The properties of the Database. |
↳ database_id |
string
Optional. The database ID of the Database. |
↳ db_home_name |
string
Optional. The name of the DbHome resource associated with the Database. |
↳ gcp_oracle_zone |
string
Output only. The GCP Oracle zone where the Database is created. |
↳ ops_insights_status |
int
Output only. The Status of Operations Insights for this Database. |
↳ pluggable_database_id |
string
Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location. |
↳ pluggable_database_name |
string
Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. |
getName
Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDbName
Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters.
Special characters are not permitted.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDbName
Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters.
Special characters are not permitted.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDbUniqueName
Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDbUniqueName
Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdminPassword
Optional. The password for the default ADMIN user.
Note: Only one of admin_password_secret_version or admin_password can
be populated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdminPassword
Optional. The password for the default ADMIN user.
Note: Only one of admin_password_secret_version or admin_password can
be populated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdminPasswordSecretVersion
Optional. The resource name of a secret version in Secret Manager which
contains the database admin user's password. Format:
projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of
admin_password_secret_version or admin_password can be populated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAdminPasswordSecretVersion
Optional. The resource name of a secret version in Secret Manager which
contains the database admin user's password. Format:
projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of
admin_password_secret_version or admin_password can be populated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTdeWalletPassword
Optional. The TDE wallet password for the database.
Note: Only one of tde_wallet_password_secret_version or
tde_wallet_password can be populated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTdeWalletPassword
Optional. The TDE wallet password for the database.
Note: Only one of tde_wallet_password_secret_version or
tde_wallet_password can be populated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTdeWalletPasswordSecretVersion
Optional. The resource name of a secret version in Secret Manager which
contains the TDE wallet password for the database. Format:
projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of
tde_wallet_password_secret_version or tde_wallet_password can be
populated.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTdeWalletPasswordSecretVersion
Optional. The resource name of a secret version in Secret Manager which
contains the TDE wallet password for the database. Format:
projects/{project}/secrets/{secret}/versions/{version}. Note: Only one of
tde_wallet_password_secret_version or tde_wallet_password can be
populated.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCharacterSet
Optional. The character set for the database. The default is AL32UTF8.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCharacterSet
Optional. The character set for the database. The default is AL32UTF8.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNcharacterSet
Optional. The national character set for the database. The default is AL16UTF16.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNcharacterSet
Optional. The national character set for the database. The default is AL16UTF16.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOciUrl
Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOciUrl
Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The date and time that the Database was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The date and time that the Database was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProperties
Optional. The properties of the Database.
| Returns | |
|---|---|
| Type | Description |
DatabaseProperties|null |
|
hasProperties
clearProperties
setProperties
Optional. The properties of the Database.
| Parameter | |
|---|---|
| Name | Description |
var |
DatabaseProperties
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseId
Optional. The database ID of the Database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseId
Optional. The database ID of the Database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDbHomeName
Optional. The name of the DbHome resource associated with the Database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDbHomeName
Optional. The name of the DbHome resource associated with the Database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcpOracleZone
Output only. The GCP Oracle zone where the Database is created.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGcpOracleZone
Output only. The GCP Oracle zone where the Database is created.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOpsInsightsStatus
Output only. The Status of Operations Insights for this Database.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type OperationsInsightsStatus. |
setOpsInsightsStatus
Output only. The Status of Operations Insights for this Database.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type OperationsInsightsStatus. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPluggableDatabaseId
Optional. The ID of the pluggable database associated with the Database.
The ID must be unique within the project and location.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPluggableDatabaseId
Optional. The ID of the pluggable database associated with the Database.
The ID must be unique within the project and location.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPluggableDatabaseName
Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPluggableDatabaseName
Optional. The pluggable database associated with the Database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|