DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster¶

class oci.distributed_database.models.DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster(**kwargs)¶

Bases: oci.distributed_database.models.distributed_database_catalog.DistributedDatabaseCatalog

Globally distributed database catalog based on ExaDbXs.

Attributes

`SOURCE_EXADB_XS`	str(object=’’) -> str
`SOURCE_EXISTING_CLUSTER`	str(object=’’) -> str
`SOURCE_NEW_VAULT_AND_CLUSTER`	str(object=’’) -> str
`STATUS_CONFIGURED`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_CREATED`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_CREATING`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_DELETED`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_DELETING`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_FAILED`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_NEEDS_ATTENTION`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_READY_FOR_CONFIGURATION`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`STATUS_UPDATING`	A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`availability_domain`	Gets the availability_domain of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`container_database_id`	Gets the container_database_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`db_home_id`	Gets the db_home_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`db_storage_vault_details`	Gets the db_storage_vault_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`kms_key_id`	Gets the kms_key_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`kms_key_version_id`	Gets the kms_key_version_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`metadata`	Gets the metadata of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`name`	[Required] Gets the name of this DistributedDatabaseCatalog.
`peer_details`	Gets the peer_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`shard_group`	[Required] Gets the shard_group of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`source`	[Required] Gets the source of this DistributedDatabaseCatalog.
`status`	[Required] Gets the status of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`supporting_resource_id`	Gets the supporting_resource_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`time_created`	[Required] Gets the time_created of this DistributedDatabaseCatalog.
`time_updated`	[Required] Gets the time_updated of this DistributedDatabaseCatalog.
`vault_id`	Gets the vault_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
`vm_cluster_details`	Gets the vm_cluster_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.

Methods

`__init__`(**kwargs)	Initializes a new DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

SOURCE_EXADB_XS = 'EXADB_XS'¶

SOURCE_EXISTING_CLUSTER = 'EXISTING_CLUSTER'¶

SOURCE_NEW_VAULT_AND_CLUSTER = 'NEW_VAULT_AND_CLUSTER'¶

STATUS_CONFIGURED = 'CONFIGURED'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “CONFIGURED”

STATUS_CREATED = 'CREATED'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “CREATED”

STATUS_CREATING = 'CREATING'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “CREATING”

STATUS_DELETED = 'DELETED'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “DELETED”

STATUS_DELETING = 'DELETING'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “DELETING”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “FAILED”

STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “NEEDS_ATTENTION”

STATUS_READY_FOR_CONFIGURATION = 'READY_FOR_CONFIGURATION'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “READY_FOR_CONFIGURATION”

STATUS_UPDATING = 'UPDATING'¶: A constant which can be used with the status property of a DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster object with values from keyword arguments. The default value of the source attribute of this class is NEW_VAULT_AND_CLUSTER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

source (str) – The value to assign to the source property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. Allowed values for this property are: “EXADB_XS”, “NEW_VAULT_AND_CLUSTER”, “EXISTING_CLUSTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
name (str) – The value to assign to the name property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
time_created (datetime) – The value to assign to the time_created property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
db_home_id (str) – The value to assign to the db_home_id property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
shard_group (str) – The value to assign to the shard_group property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
vault_id (str) – The value to assign to the vault_id property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
kms_key_id (str) – The value to assign to the kms_key_id property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
status (str) – The value to assign to the status property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. Allowed values for this property are: “FAILED”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “CREATED”, “READY_FOR_CONFIGURATION”, “CONFIGURED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
supporting_resource_id (str) – The value to assign to the supporting_resource_id property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
container_database_id (str) – The value to assign to the container_database_id property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
availability_domain (str) – The value to assign to the availability_domain property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
db_storage_vault_details (oci.distributed_database.models.DistributedDbStorageVault) – The value to assign to the db_storage_vault_details property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
vm_cluster_details (oci.distributed_database.models.DistributedDbVmCluster) – The value to assign to the vm_cluster_details property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
peer_details (list[oci.distributed_database.models.CatalogPeerWithExadbXsNewVaultAndCluster]) – The value to assign to the peer_details property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
metadata (oci.distributed_database.models.DistributedDbMetadata) – The value to assign to the metadata property of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.

availability_domain¶

Gets the availability_domain of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. The name of the availability domain that the distributed database catalog will be located in.

Returns:	The availability_domain of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

container_database_id¶

Gets the container_database_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. the identifier of the container database for underlying supporting resource.

Returns:	The container_database_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

db_home_id¶

Gets the db_home_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. The OCID of the Database Home.

Returns:	The db_home_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

db_storage_vault_details¶

Gets the db_storage_vault_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.

Returns:	The db_storage_vault_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	oci.distributed_database.models.DistributedDbStorageVault

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

kms_key_id¶

Gets the kms_key_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:	The kms_key_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.

Returns:	The kms_key_version_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

metadata¶

Gets the metadata of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.

Returns:	The metadata of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	oci.distributed_database.models.DistributedDbMetadata

name¶

[Required] Gets the name of this DistributedDatabaseCatalog. The name of catalog.

Returns:	The name of this DistributedDatabaseCatalog.
Return type:	str

peer_details¶

Gets the peer_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. Peer details for the catalog.

Returns:	The peer_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	list[oci.distributed_database.models.CatalogPeerWithExadbXsNewVaultAndCluster]

shard_group¶

[Required] Gets the shard_group of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. The name of the shardGroup for the catalog.

Returns:	The shard_group of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

source¶

[Required] Gets the source of this DistributedDatabaseCatalog. Type of Globally distributed database Shard or Catalog. Use NEW_VAULT_AND_CLUSTER for a Globally distributed database on Exascale with new vaults and clusters created from scratch. Use EXISTING_CLUSTER for a Globally distributed database on Exascale based on pre-existing clusters. EXADB_XS is currently the same as EXISTING_CLUSTER and will be deprecated after the deprecation cycle.

Allowed values for this property are: “EXADB_XS”, “NEW_VAULT_AND_CLUSTER”, “EXISTING_CLUSTER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The source of this DistributedDatabaseCatalog.
Return type:	str

status¶

[Required] Gets the status of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. Status of EXADB_XS based catalog.

Allowed values for this property are: “FAILED”, “DELETING”, “DELETED”, “UPDATING”, “CREATING”, “CREATED”, “READY_FOR_CONFIGURATION”, “CONFIGURED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

supporting_resource_id¶

Gets the supporting_resource_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. the identifier of the underlying supporting resource.

Returns:	The supporting_resource_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

time_created¶

[Required] Gets the time_created of this DistributedDatabaseCatalog. The time the catalog was created. An RFC3339 formatted datetime string

Returns:	The time_created of this DistributedDatabaseCatalog.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this DistributedDatabaseCatalog. The time the catalog was last updated. An RFC3339 formatted datetime string

Returns:	The time_updated of this DistributedDatabaseCatalog.
Return type:	datetime

vault_id¶

Gets the vault_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster. The OCID of the Oracle Cloud Infrastructure vault. This parameter and kmsKeyId are required for Customer Managed Keys.

Returns:	The vault_id of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	str

vm_cluster_details¶

Gets the vm_cluster_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.

Returns:	The vm_cluster_details of this DistributedDatabaseCatalogWithExadbXsNewVaultAndCluster.
Return type:	oci.distributed_database.models.DistributedDbVmCluster