DistributedDatabaseShardWithExadbXs¶

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

Bases: oci.distributed_database.models.distributed_database_shard.DistributedDatabaseShard

Globally distributed database shard based on exadbxs.

Attributes

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

Methods

`__init__`(**kwargs)	Initializes a new DistributedDatabaseShardWithExadbXs 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'¶

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

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

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

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

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

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

STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the status property of a DistributedDatabaseShardWithExadbXs. 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 DistributedDatabaseShardWithExadbXs. This constant has a value of “READY_FOR_CONFIGURATION”

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

__init__(**kwargs)¶

Initializes a new DistributedDatabaseShardWithExadbXs object with values from keyword arguments. The default value of the source attribute of this class is EXADB_XS 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 DistributedDatabaseShardWithExadbXs. Allowed values for this property are: “EXADB_XS”, ‘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 DistributedDatabaseShardWithExadbXs.
time_created (datetime) – The value to assign to the time_created property of this DistributedDatabaseShardWithExadbXs.
time_updated (datetime) – The value to assign to the time_updated property of this DistributedDatabaseShardWithExadbXs.
db_home_id (str) – The value to assign to the db_home_id property of this DistributedDatabaseShardWithExadbXs.
shard_group (str) – The value to assign to the shard_group property of this DistributedDatabaseShardWithExadbXs.
vm_cluster_id (str) – The value to assign to the vm_cluster_id property of this DistributedDatabaseShardWithExadbXs.
shard_space (str) – The value to assign to the shard_space property of this DistributedDatabaseShardWithExadbXs.
vault_id (str) – The value to assign to the vault_id property of this DistributedDatabaseShardWithExadbXs.
kms_key_id (str) – The value to assign to the kms_key_id property of this DistributedDatabaseShardWithExadbXs.
kms_key_version_id (str) – The value to assign to the kms_key_version_id property of this DistributedDatabaseShardWithExadbXs.
status (str) – The value to assign to the status property of this DistributedDatabaseShardWithExadbXs. 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 DistributedDatabaseShardWithExadbXs.
container_database_id (str) – The value to assign to the container_database_id property of this DistributedDatabaseShardWithExadbXs.
peer_details (list[oci.distributed_database.models.ShardPeerWithExadbXs]) – The value to assign to the peer_details property of this DistributedDatabaseShardWithExadbXs.
metadata (oci.distributed_database.models.DistributedDbMetadata) – The value to assign to the metadata property of this DistributedDatabaseShardWithExadbXs.

container_database_id¶

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

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

db_home_id¶

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

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

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 DistributedDatabaseShardWithExadbXs. 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 DistributedDatabaseShardWithExadbXs.
Return type:	str

kms_key_version_id¶

Gets the kms_key_version_id of this DistributedDatabaseShardWithExadbXs. 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 DistributedDatabaseShardWithExadbXs.
Return type:	str

metadata¶

Gets the metadata of this DistributedDatabaseShardWithExadbXs.

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

name¶

[Required] Gets the name of this DistributedDatabaseShard. Name of the shard.

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

peer_details¶

Gets the peer_details of this DistributedDatabaseShardWithExadbXs. Peer details for the shard.

Returns:	The peer_details of this DistributedDatabaseShardWithExadbXs.
Return type:	list[oci.distributed_database.models.ShardPeerWithExadbXs]

shard_group¶

[Required] Gets the shard_group of this DistributedDatabaseShardWithExadbXs. The name of the shardGroup for the shard.

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

shard_space¶

Gets the shard_space of this DistributedDatabaseShardWithExadbXs. The shard space name for the Globally distributed database. Shard space for existing shard cannot be changed, once shard is created. Shard space name shall be used while creation of new shards.

Returns:	The shard_space of this DistributedDatabaseShardWithExadbXs.
Return type:	str

source¶

[Required] Gets the source of this DistributedDatabaseShard. The source of Globally distributed database type: Use EXADB_XS for the Globally distributed database with Exascale based distributed database.

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

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

status¶

[Required] Gets the status of this DistributedDatabaseShardWithExadbXs. Status of shard based on exadbxs for the Globally ditributed database.

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 DistributedDatabaseShardWithExadbXs.
Return type:	str

supporting_resource_id¶

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

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

time_created¶

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

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

time_updated¶

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

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

vault_id¶

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

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

vm_cluster_id¶

[Required] Gets the vm_cluster_id of this DistributedDatabaseShardWithExadbXs. The OCID of the VmCluster.

Returns:	The vm_cluster_id of this DistributedDatabaseShardWithExadbXs.
Return type:	str