Class Database (0.42.0) 

public final class Database extends GeneratedMessage implements DatabaseOrBuilder

Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/

Protobuf type google.cloud.oracledatabase.v1.Database

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Database

Implements

DatabaseOrBuilder

Static Fields

ADMIN_PASSWORD_FIELD_NUMBER

public static final int ADMIN_PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

ADMIN_PASSWORD_SECRET_VERSION_FIELD_NUMBER

public static final int ADMIN_PASSWORD_SECRET_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CHARACTER_SET_FIELD_NUMBER

public static final int CHARACTER_SET_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

DB_HOME_NAME_FIELD_NUMBER

public static final int DB_HOME_NAME_FIELD_NUMBER
Field Value
Type Description
int

DB_NAME_FIELD_NUMBER

public static final int DB_NAME_FIELD_NUMBER
Field Value
Type Description
int

DB_UNIQUE_NAME_FIELD_NUMBER

public static final int DB_UNIQUE_NAME_FIELD_NUMBER
Field Value
Type Description
int

GCP_ORACLE_ZONE_FIELD_NUMBER

public static final int GCP_ORACLE_ZONE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NCHARACTER_SET_FIELD_NUMBER

public static final int NCHARACTER_SET_FIELD_NUMBER
Field Value
Type Description
int

OCI_URL_FIELD_NUMBER

public static final int OCI_URL_FIELD_NUMBER
Field Value
Type Description
int

OPS_INSIGHTS_STATUS_FIELD_NUMBER

public static final int OPS_INSIGHTS_STATUS_FIELD_NUMBER
Field Value
Type Description
int

PLUGGABLE_DATABASE_ID_FIELD_NUMBER

public static final int PLUGGABLE_DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

PLUGGABLE_DATABASE_NAME_FIELD_NUMBER

public static final int PLUGGABLE_DATABASE_NAME_FIELD_NUMBER
Field Value
Type Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

TDE_WALLET_PASSWORD_FIELD_NUMBER

public static final int TDE_WALLET_PASSWORD_FIELD_NUMBER
Field Value
Type Description
int

TDE_WALLET_PASSWORD_SECRET_VERSION_FIELD_NUMBER

public static final int TDE_WALLET_PASSWORD_SECRET_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Database getDefaultInstance()
Returns
Type Description
Database

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Database.Builder newBuilder()
Returns
Type Description
Database.Builder

newBuilder(Database prototype)

public static Database.Builder newBuilder(Database prototype)
Parameter
Name Description
prototype Database
Returns
Type Description
Database.Builder

parseDelimitedFrom(InputStream input)

public static Database parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Database
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Database parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Database
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Database parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Database
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Database parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Database
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Database parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Database
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Database parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Database
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Database parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Database
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Database> parser()
Returns
Type Description
Parser<Database>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdminPassword()

public String getAdminPassword()

Optional. The password for the default ADMIN user. Note: Only one of admin_password_secret_version or admin_password can be populated.

string admin_password = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The adminPassword.

getAdminPasswordBytes()

public ByteString getAdminPasswordBytes()

Optional. The password for the default ADMIN user. Note: Only one of admin_password_secret_version or admin_password can be populated.

string admin_password = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for adminPassword.

getAdminPasswordSecretVersion()

public String 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.

string admin_password_secret_version = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The adminPasswordSecretVersion.

getAdminPasswordSecretVersionBytes()

public ByteString getAdminPasswordSecretVersionBytes()

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.

string admin_password_secret_version = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for adminPasswordSecretVersion.

getCharacterSet()

public String getCharacterSet()

Optional. The character set for the database. The default is AL32UTF8.

string character_set = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The characterSet.

getCharacterSetBytes()

public ByteString getCharacterSetBytes()

Optional. The character set for the database. The default is AL32UTF8.

string character_set = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for characterSet.

getCreateTime()

public Timestamp getCreateTime()

Output only. The date and time that the Database was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The date and time that the Database was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDatabaseId()

public String getDatabaseId()

Optional. The database ID of the Database.

string database_id = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Optional. The database ID of the Database.

string database_id = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for databaseId.

getDbHomeName()

public String getDbHomeName()

Optional. The name of the DbHome resource associated with the Database.

string db_home_name = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The dbHomeName.

getDbHomeNameBytes()

public ByteString getDbHomeNameBytes()

Optional. The name of the DbHome resource associated with the Database.

string db_home_name = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for dbHomeName.

getDbName()

public String 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.

string db_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The dbName.

getDbNameBytes()

public ByteString getDbNameBytes()

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.

string db_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for dbName.

getDbUniqueName()

public String getDbUniqueName()

Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.

string db_unique_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The dbUniqueName.

getDbUniqueNameBytes()

public ByteString getDbUniqueNameBytes()

Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.

string db_unique_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for dbUniqueName.

getDefaultInstanceForType()

public Database getDefaultInstanceForType()
Returns
Type Description
Database

getGcpOracleZone()

public String getGcpOracleZone()

Output only. The GCP Oracle zone where the Database is created.

string gcp_oracle_zone = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The gcpOracleZone.

getGcpOracleZoneBytes()

public ByteString getGcpOracleZoneBytes()

Output only. The GCP Oracle zone where the Database is created.

string gcp_oracle_zone = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for gcpOracleZone.

getName()

public String getName()

Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNcharacterSet()

public String getNcharacterSet()

Optional. The national character set for the database. The default is AL16UTF16.

string ncharacter_set = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The ncharacterSet.

getNcharacterSetBytes()

public ByteString getNcharacterSetBytes()

Optional. The national character set for the database. The default is AL16UTF16.

string ncharacter_set = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for ncharacterSet.

getOciUrl()

public String getOciUrl()

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.

string oci_url = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The ociUrl.

getOciUrlBytes()

public ByteString getOciUrlBytes()

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.

string oci_url = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for ociUrl.

getOpsInsightsStatus()

public Database.OperationsInsightsStatus getOpsInsightsStatus()

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

.google.cloud.oracledatabase.v1.Database.OperationsInsightsStatus ops_insights_status = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Database.OperationsInsightsStatus

The opsInsightsStatus.

getOpsInsightsStatusValue()

public int getOpsInsightsStatusValue()

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

.google.cloud.oracledatabase.v1.Database.OperationsInsightsStatus ops_insights_status = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for opsInsightsStatus.

getParserForType()

public Parser<Database> getParserForType()
Returns
Type Description
Parser<Database>
Overrides

getPluggableDatabaseId()

public String getPluggableDatabaseId()

Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.

string pluggable_database_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pluggableDatabaseId.

getPluggableDatabaseIdBytes()

public ByteString getPluggableDatabaseIdBytes()

Optional. The ID of the pluggable database associated with the Database. The ID must be unique within the project and location.

string pluggable_database_id = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pluggableDatabaseId.

getPluggableDatabaseName()

public String 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.

string pluggable_database_name = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pluggableDatabaseName.

getPluggableDatabaseNameBytes()

public ByteString getPluggableDatabaseNameBytes()

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.

string pluggable_database_name = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pluggableDatabaseName.

getProperties()

public DatabaseProperties getProperties()

Optional. The properties of the Database.

.google.cloud.oracledatabase.v1.DatabaseProperties properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabaseProperties

The properties.

getPropertiesOrBuilder()

public DatabasePropertiesOrBuilder getPropertiesOrBuilder()

Optional. The properties of the Database.

.google.cloud.oracledatabase.v1.DatabaseProperties properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DatabasePropertiesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTdeWalletPassword()

public String 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.

string tde_wallet_password = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The tdeWalletPassword.

getTdeWalletPasswordBytes()

public ByteString getTdeWalletPasswordBytes()

Optional. The TDE wallet password for the database. Note: Only one of tde_wallet_password_secret_version or tde_wallet_password can be populated.

string tde_wallet_password = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for tdeWalletPassword.

getTdeWalletPasswordSecretVersion()

public String 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.

string tde_wallet_password_secret_version = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tdeWalletPasswordSecretVersion.

getTdeWalletPasswordSecretVersionBytes()

public ByteString getTdeWalletPasswordSecretVersionBytes()

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.

string tde_wallet_password_secret_version = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tdeWalletPasswordSecretVersion.

hasCreateTime()

public boolean hasCreateTime()

Output only. The date and time that the Database was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasProperties()

public boolean hasProperties()

Optional. The properties of the Database.

.google.cloud.oracledatabase.v1.DatabaseProperties properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the properties field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Database.Builder newBuilderForType()
Returns
Type Description
Database.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Database.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Database.Builder
Overrides

toBuilder()

public Database.Builder toBuilder()
Returns
Type Description
Database.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException