Class PluggableDatabaseProperties (0.29.0)

public final class PluggableDatabaseProperties extends GeneratedMessageV3 implements PluggableDatabasePropertiesOrBuilder

The properties of a PluggableDatabase.

Protobuf type google.cloud.oracledatabase.v1.PluggableDatabaseProperties

Static Fields

COMPARTMENT_ID_FIELD_NUMBER

public static final int COMPARTMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

CONNECTION_STRINGS_FIELD_NUMBER

public static final int CONNECTION_STRINGS_FIELD_NUMBER
Field Value
Type Description
int

CONTAINER_DATABASE_OCID_FIELD_NUMBER

public static final int CONTAINER_DATABASE_OCID_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_MANAGEMENT_CONFIG_FIELD_NUMBER

public static final int DATABASE_MANAGEMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DEFINED_TAGS_FIELD_NUMBER

public static final int DEFINED_TAGS_FIELD_NUMBER
Field Value
Type Description
int

FREEFORM_TAGS_FIELD_NUMBER

public static final int FREEFORM_TAGS_FIELD_NUMBER
Field Value
Type Description
int

IS_RESTRICTED_FIELD_NUMBER

public static final int IS_RESTRICTED_FIELD_NUMBER
Field Value
Type Description
int

LIFECYCLE_DETAILS_FIELD_NUMBER

public static final int LIFECYCLE_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

LIFECYCLE_STATE_FIELD_NUMBER

public static final int LIFECYCLE_STATE_FIELD_NUMBER
Field Value
Type Description
int

OCID_FIELD_NUMBER

public static final int OCID_FIELD_NUMBER
Field Value
Type Description
int

OPERATIONS_INSIGHTS_STATE_FIELD_NUMBER

public static final int OPERATIONS_INSIGHTS_STATE_FIELD_NUMBER
Field Value
Type Description
int

PDB_NAME_FIELD_NUMBER

public static final int PDB_NAME_FIELD_NUMBER
Field Value
Type Description
int

PDB_NODE_LEVEL_DETAILS_FIELD_NUMBER

public static final int PDB_NODE_LEVEL_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PluggableDatabaseProperties getDefaultInstance()
Returns
Type Description
PluggableDatabaseProperties

getDescriptor()

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

newBuilder()

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

newBuilder(PluggableDatabaseProperties prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsDefinedTags(String key)

public boolean containsDefinedTags(String key)

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

map<string, .google.cloud.oracledatabase.v1.PluggableDatabaseProperties.DefinedTagValue> defined_tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsFreeformTags(String key)

public boolean containsFreeformTags(String key)

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

map<string, string> freeform_tags = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getCompartmentId()

public String getCompartmentId()

Required. The OCID of the compartment.

string compartment_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The compartmentId.

getCompartmentIdBytes()

public ByteString getCompartmentIdBytes()

Required. The OCID of the compartment.

string compartment_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for compartmentId.

getConnectionStrings()

public PluggableDatabaseConnectionStrings getConnectionStrings()

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

.google.cloud.oracledatabase.v1.PluggableDatabaseConnectionStrings connection_strings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PluggableDatabaseConnectionStrings

The connectionStrings.

getConnectionStringsOrBuilder()

public PluggableDatabaseConnectionStringsOrBuilder getConnectionStringsOrBuilder()

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

.google.cloud.oracledatabase.v1.PluggableDatabaseConnectionStrings connection_strings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PluggableDatabaseConnectionStringsOrBuilder

getContainerDatabaseOcid()

public String getContainerDatabaseOcid()

Required. The OCID of the CDB.

string container_database_ocid = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The containerDatabaseOcid.

getContainerDatabaseOcidBytes()

public ByteString getContainerDatabaseOcidBytes()

Required. The OCID of the CDB.

string container_database_ocid = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for containerDatabaseOcid.

getDatabaseManagementConfig()

public DatabaseManagementConfig getDatabaseManagementConfig()

Output only. The configuration of the Database Management service.

.google.cloud.oracledatabase.v1.DatabaseManagementConfig database_management_config = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatabaseManagementConfig

The databaseManagementConfig.

getDatabaseManagementConfigOrBuilder()

public DatabaseManagementConfigOrBuilder getDatabaseManagementConfigOrBuilder()

Output only. The configuration of the Database Management service.

.google.cloud.oracledatabase.v1.DatabaseManagementConfig database_management_config = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DatabaseManagementConfigOrBuilder

getDefaultInstanceForType()

public PluggableDatabaseProperties getDefaultInstanceForType()
Returns
Type Description
PluggableDatabaseProperties

getDefinedTags() (deprecated)

public Map<String,PluggableDatabaseProperties.DefinedTagValue> getDefinedTags()

Use #getDefinedTagsMap() instead.

Returns
Type Description
Map<String,DefinedTagValue>

getDefinedTagsCount()

public int getDefinedTagsCount()

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

map<string, .google.cloud.oracledatabase.v1.PluggableDatabaseProperties.DefinedTagValue> defined_tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDefinedTagsMap()

public Map<String,PluggableDatabaseProperties.DefinedTagValue> getDefinedTagsMap()

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

map<string, .google.cloud.oracledatabase.v1.PluggableDatabaseProperties.DefinedTagValue> defined_tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,DefinedTagValue>

getDefinedTagsOrDefault(String key, PluggableDatabaseProperties.DefinedTagValue defaultValue)

public PluggableDatabaseProperties.DefinedTagValue getDefinedTagsOrDefault(String key, PluggableDatabaseProperties.DefinedTagValue defaultValue)

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

map<string, .google.cloud.oracledatabase.v1.PluggableDatabaseProperties.DefinedTagValue> defined_tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue PluggableDatabaseProperties.DefinedTagValue
Returns
Type Description
PluggableDatabaseProperties.DefinedTagValue

getDefinedTagsOrThrow(String key)

public PluggableDatabaseProperties.DefinedTagValue getDefinedTagsOrThrow(String key)

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

map<string, .google.cloud.oracledatabase.v1.PluggableDatabaseProperties.DefinedTagValue> defined_tags = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
PluggableDatabaseProperties.DefinedTagValue

getFreeformTags() (deprecated)

public Map<String,String> getFreeformTags()

Use #getFreeformTagsMap() instead.

Returns
Type Description
Map<String,String>

getFreeformTagsCount()

public int getFreeformTagsCount()

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

map<string, string> freeform_tags = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getFreeformTagsMap()

public Map<String,String> getFreeformTagsMap()

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

map<string, string> freeform_tags = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getFreeformTagsOrDefault(String key, String defaultValue)

public String getFreeformTagsOrDefault(String key, String defaultValue)

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

map<string, string> freeform_tags = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getFreeformTagsOrThrow(String key)

public String getFreeformTagsOrThrow(String key)

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

map<string, string> freeform_tags = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getIsRestricted()

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

bool is_restricted = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isRestricted.

getLifecycleDetails()

public String getLifecycleDetails()

Output only. Additional information about the current lifecycle state.

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

Returns
Type Description
String

The lifecycleDetails.

getLifecycleDetailsBytes()

public ByteString getLifecycleDetailsBytes()

Output only. Additional information about the current lifecycle state.

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

Returns
Type Description
ByteString

The bytes for lifecycleDetails.

getLifecycleState()

public PluggableDatabaseProperties.PluggableDatabaseLifecycleState getLifecycleState()

Output only. The current state of the pluggable database.

.google.cloud.oracledatabase.v1.PluggableDatabaseProperties.PluggableDatabaseLifecycleState lifecycle_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PluggableDatabaseProperties.PluggableDatabaseLifecycleState

The lifecycleState.

getLifecycleStateValue()

public int getLifecycleStateValue()

Output only. The current state of the pluggable database.

.google.cloud.oracledatabase.v1.PluggableDatabaseProperties.PluggableDatabaseLifecycleState lifecycle_state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for lifecycleState.

getOcid()

public String getOcid()

Output only. The OCID of the pluggable database.

string ocid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The ocid.

getOcidBytes()

public ByteString getOcidBytes()

Output only. The OCID of the pluggable database.

string ocid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for ocid.

getOperationsInsightsState()

public PluggableDatabaseProperties.OperationsInsightsState getOperationsInsightsState()

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

.google.cloud.oracledatabase.v1.PluggableDatabaseProperties.OperationsInsightsState operations_insights_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PluggableDatabaseProperties.OperationsInsightsState

The operationsInsightsState.

getOperationsInsightsStateValue()

public int getOperationsInsightsStateValue()

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

.google.cloud.oracledatabase.v1.PluggableDatabaseProperties.OperationsInsightsState operations_insights_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for operationsInsightsState.

getParserForType()

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

getPdbName()

public String getPdbName()

Required. The database name.

string pdb_name = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The pdbName.

getPdbNameBytes()

public ByteString getPdbNameBytes()

Required. The database name.

string pdb_name = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for pdbName.

getPdbNodeLevelDetails(int index)

public PluggableDatabaseNodeLevelDetails getPdbNodeLevelDetails(int index)

Optional. Pluggable Database Node Level Details

repeated .google.cloud.oracledatabase.v1.PluggableDatabaseNodeLevelDetails pdb_node_level_details = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
PluggableDatabaseNodeLevelDetails

getPdbNodeLevelDetailsCount()

public int getPdbNodeLevelDetailsCount()

Optional. Pluggable Database Node Level Details

repeated .google.cloud.oracledatabase.v1.PluggableDatabaseNodeLevelDetails pdb_node_level_details = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPdbNodeLevelDetailsList()

public List<PluggableDatabaseNodeLevelDetails> getPdbNodeLevelDetailsList()

Optional. Pluggable Database Node Level Details

repeated .google.cloud.oracledatabase.v1.PluggableDatabaseNodeLevelDetails pdb_node_level_details = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<PluggableDatabaseNodeLevelDetails>

getPdbNodeLevelDetailsOrBuilder(int index)

public PluggableDatabaseNodeLevelDetailsOrBuilder getPdbNodeLevelDetailsOrBuilder(int index)

Optional. Pluggable Database Node Level Details

repeated .google.cloud.oracledatabase.v1.PluggableDatabaseNodeLevelDetails pdb_node_level_details = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
PluggableDatabaseNodeLevelDetailsOrBuilder

getPdbNodeLevelDetailsOrBuilderList()

public List<? extends PluggableDatabaseNodeLevelDetailsOrBuilder> getPdbNodeLevelDetailsOrBuilderList()

Optional. Pluggable Database Node Level Details

repeated .google.cloud.oracledatabase.v1.PluggableDatabaseNodeLevelDetails pdb_node_level_details = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.oracledatabase.v1.PluggableDatabaseNodeLevelDetailsOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConnectionStrings()

public boolean hasConnectionStrings()

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

.google.cloud.oracledatabase.v1.PluggableDatabaseConnectionStrings connection_strings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the connectionStrings field is set.

hasDatabaseManagementConfig()

public boolean hasDatabaseManagementConfig()

Output only. The configuration of the Database Management service.

.google.cloud.oracledatabase.v1.DatabaseManagementConfig database_management_config = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the databaseManagementConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PluggableDatabaseProperties.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PluggableDatabaseProperties.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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