DedicatedShardDetails¶

class oci.globally_distributed_database.models.DedicatedShardDetails(**kwargs)¶

Bases: object

Details of ATP-D based shard.

Attributes

`STATUS_CONFIGURED`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_CREATED`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_CREATING`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_DELETED`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_DELETING`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_FAILED`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_NEEDS_ATTENTION`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_READY_FOR_CONFIGURATION`	A constant which can be used with the status property of a DedicatedShardDetails.
`STATUS_UPDATING`	A constant which can be used with the status property of a DedicatedShardDetails.
`cloud_autonomous_vm_cluster_id`	[Required] Gets the cloud_autonomous_vm_cluster_id of this DedicatedShardDetails.
`compute_count`	[Required] Gets the compute_count of this DedicatedShardDetails.
`container_database_id`	Gets the container_database_id of this DedicatedShardDetails.
`container_database_parent_id`	Gets the container_database_parent_id of this DedicatedShardDetails.
`data_storage_size_in_gbs`	[Required] Gets the data_storage_size_in_gbs of this DedicatedShardDetails.
`encryption_key_details`	Gets the encryption_key_details of this DedicatedShardDetails.
`is_auto_scaling_enabled`	[Required] Gets the is_auto_scaling_enabled of this DedicatedShardDetails.
`metadata`	Gets the metadata of this DedicatedShardDetails.
`name`	[Required] Gets the name of this DedicatedShardDetails.
`peer_cloud_autonomous_vm_cluster_id`	Gets the peer_cloud_autonomous_vm_cluster_id of this DedicatedShardDetails.
`shard_group`	[Required] Gets the shard_group of this DedicatedShardDetails.
`shard_space`	Gets the shard_space of this DedicatedShardDetails.
`status`	[Required] Gets the status of this DedicatedShardDetails.
`supporting_resource_id`	Gets the supporting_resource_id of this DedicatedShardDetails.
`time_created`	[Required] Gets the time_created of this DedicatedShardDetails.
`time_ssl_certificate_expires`	Gets the time_ssl_certificate_expires of this DedicatedShardDetails.
`time_updated`	[Required] Gets the time_updated of this DedicatedShardDetails.

Methods

__init__(**kwargs) Initializes a new DedicatedShardDetails object with values from keyword arguments.

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

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new DedicatedShardDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

encryption_key_details (oci.globally_distributed_database.models.DedicatedShardOrCatalogEncryptionKeyDetails) – The value to assign to the encryption_key_details property of this DedicatedShardDetails.
name (str) – The value to assign to the name property of this DedicatedShardDetails.
compute_count (float) – The value to assign to the compute_count property of this DedicatedShardDetails.
data_storage_size_in_gbs (float) – The value to assign to the data_storage_size_in_gbs property of this DedicatedShardDetails.
shard_group (str) – The value to assign to the shard_group property of this DedicatedShardDetails.
time_created (datetime) – The value to assign to the time_created property of this DedicatedShardDetails.
time_updated (datetime) – The value to assign to the time_updated property of this DedicatedShardDetails.
time_ssl_certificate_expires (datetime) – The value to assign to the time_ssl_certificate_expires property of this DedicatedShardDetails.
status (str) – The value to assign to the status property of this DedicatedShardDetails. 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’.
shard_space (str) – The value to assign to the shard_space property of this DedicatedShardDetails.
supporting_resource_id (str) – The value to assign to the supporting_resource_id property of this DedicatedShardDetails.
container_database_id (str) – The value to assign to the container_database_id property of this DedicatedShardDetails.
container_database_parent_id (str) – The value to assign to the container_database_parent_id property of this DedicatedShardDetails.
is_auto_scaling_enabled (bool) – The value to assign to the is_auto_scaling_enabled property of this DedicatedShardDetails.
cloud_autonomous_vm_cluster_id (str) – The value to assign to the cloud_autonomous_vm_cluster_id property of this DedicatedShardDetails.
peer_cloud_autonomous_vm_cluster_id (str) – The value to assign to the peer_cloud_autonomous_vm_cluster_id property of this DedicatedShardDetails.
metadata (dict(str, object)) – The value to assign to the metadata property of this DedicatedShardDetails.

cloud_autonomous_vm_cluster_id¶

[Required] Gets the cloud_autonomous_vm_cluster_id of this DedicatedShardDetails. Identifier of the primary cloudAutonomousVmCluster for the shard.

Returns:	The cloud_autonomous_vm_cluster_id of this DedicatedShardDetails.
Return type:	str

compute_count¶

[Required] Gets the compute_count of this DedicatedShardDetails. The compute amount available to the underlying autonomous database associated with shard.

Returns:	The compute_count of this DedicatedShardDetails.
Return type:	float

container_database_id¶

Gets the container_database_id of this DedicatedShardDetails. Identifier of the underlying container database.

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

container_database_parent_id¶

Gets the container_database_parent_id of this DedicatedShardDetails. Identifier of the underlying container database parent.

Returns:	The container_database_parent_id of this DedicatedShardDetails.
Return type:	str

data_storage_size_in_gbs¶

[Required] Gets the data_storage_size_in_gbs of this DedicatedShardDetails. The data disk group size to be allocated in GBs.

Returns:	The data_storage_size_in_gbs of this DedicatedShardDetails.
Return type:	float

encryption_key_details¶

Gets the encryption_key_details of this DedicatedShardDetails.

Returns:	The encryption_key_details of this DedicatedShardDetails.
Return type:	oci.globally_distributed_database.models.DedicatedShardOrCatalogEncryptionKeyDetails

is_auto_scaling_enabled¶

[Required] Gets the is_auto_scaling_enabled of this DedicatedShardDetails. Determines the auto-scaling mode.

Returns:	The is_auto_scaling_enabled of this DedicatedShardDetails.
Return type:	bool

metadata¶

Gets the metadata of this DedicatedShardDetails. Additional metadata related to shard’s underlying supporting resource.

Returns:	The metadata of this DedicatedShardDetails.
Return type:	dict(str, object)

name¶

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

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

peer_cloud_autonomous_vm_cluster_id¶

Gets the peer_cloud_autonomous_vm_cluster_id of this DedicatedShardDetails. Identifier of the peer cloudAutonomousVmCluster for the shard.

Returns:	The peer_cloud_autonomous_vm_cluster_id of this DedicatedShardDetails.
Return type:	str

shard_group¶

[Required] Gets the shard_group of this DedicatedShardDetails. Name of the shard-group to which the shard belongs.

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

shard_space¶

Gets the shard_space of this DedicatedShardDetails. Shard space name.

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

status¶

[Required] Gets the status of this DedicatedShardDetails. Status of shard or catalog or gsm for the sharded 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 DedicatedShardDetails.
Return type:	str

supporting_resource_id¶

Gets the supporting_resource_id of this DedicatedShardDetails. Identifier of the underlying supporting resource.

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

time_created¶

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

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

time_ssl_certificate_expires¶

Gets the time_ssl_certificate_expires of this DedicatedShardDetails. The time the ssl certificate associated with shard expires. An RFC3339 formatted datetime string

Returns:	The time_ssl_certificate_expires of this DedicatedShardDetails.
Return type:	datetime

time_updated¶

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

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