TableSummary¶
- class oci.nosql.models.TableSummary(**kwargs)¶
Bases:
objectSummary of the table.
Attributes:
A constant which can be used with the schema_state property of a TableSummary.
A constant which can be used with the schema_state property of a TableSummary.
[Required] Gets the compartment_id of this TableSummary.
Gets the defined_tags of this TableSummary.
Gets the freeform_tags of this TableSummary.
[Required] Gets the id of this TableSummary.
Gets the is_auto_reclaimable of this TableSummary.
Gets the is_multi_region of this TableSummary.
Gets the lifecycle_details of this TableSummary.
Gets the lifecycle_state of this TableSummary.
Gets the name of this TableSummary.
Gets the schema_state of this TableSummary.
Gets the system_tags of this TableSummary.
Gets the table_limits of this TableSummary.
Gets the time_created of this TableSummary.
Gets the time_of_expiration of this TableSummary.
Gets the time_updated of this TableSummary.
Methods:
__init__(**kwargs)Initializes a new TableSummary object with values from keyword arguments.
- SCHEMA_STATE_FROZEN = 'FROZEN'¶
A constant which can be used with the schema_state property of a TableSummary. This constant has a value of “FROZEN”
- SCHEMA_STATE_MUTABLE = 'MUTABLE'¶
A constant which can be used with the schema_state property of a TableSummary. This constant has a value of “MUTABLE”
- __init__(**kwargs)¶
Initializes a new TableSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this TableSummary.
compartment_id (str) – The value to assign to the compartment_id property of this TableSummary.
name (str) – The value to assign to the name property of this TableSummary.
time_created (datetime) – The value to assign to the time_created property of this TableSummary.
time_updated (datetime) – The value to assign to the time_updated property of this TableSummary.
table_limits (oci.nosql.models.TableLimits) – The value to assign to the table_limits property of this TableSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TableSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this TableSummary.
is_auto_reclaimable (bool) – The value to assign to the is_auto_reclaimable property of this TableSummary.
time_of_expiration (datetime) – The value to assign to the time_of_expiration property of this TableSummary.
schema_state (str) – The value to assign to the schema_state property of this TableSummary. Allowed values for this property are: “MUTABLE”, “FROZEN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_multi_region (bool) – The value to assign to the is_multi_region property of this TableSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TableSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TableSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TableSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this TableSummary. Compartment Identifier.
- Returns
The compartment_id of this TableSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this TableSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this TableSummary.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
Gets the freeform_tags of this TableSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns
The freeform_tags of this TableSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this TableSummary. Unique identifier that is immutable on creation.
- Returns
The id of this TableSummary.
- Return type
str
- property is_auto_reclaimable¶
Gets the is_auto_reclaimable of this TableSummary. True if this table can be reclaimed after an idle period.
- Returns
The is_auto_reclaimable of this TableSummary.
- Return type
bool
- property is_multi_region¶
Gets the is_multi_region of this TableSummary. True if this table is currently a member of a replication set.
- Returns
The is_multi_region of this TableSummary.
- Return type
bool
- property lifecycle_details¶
Gets the lifecycle_details of this TableSummary. A message describing the current state in more detail.
- Returns
The lifecycle_details of this TableSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this TableSummary. The state of a table.
- Returns
The lifecycle_state of this TableSummary.
- Return type
str
- property name¶
Gets the name of this TableSummary. Human-friendly table name, also immutable.
- Returns
The name of this TableSummary.
- Return type
str
- property schema_state¶
Gets the schema_state of this TableSummary. The current state of this table’s schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.
Allowed values for this property are: “MUTABLE”, “FROZEN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The schema_state of this TableSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this TableSummary. Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is “orcl-cloud”; and the only key in that namespace is “free-tier-retained”. Example: {“orcl-cloud””: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this TableSummary.
- Return type
dict(str, dict(str, object))
- property table_limits¶
Gets the table_limits of this TableSummary.
- Returns
The table_limits of this TableSummary.
- Return type
- property time_created¶
Gets the time_created of this TableSummary. The time the the table was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this TableSummary.
- Return type
datetime
- property time_of_expiration¶
Gets the time_of_expiration of this TableSummary. If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.
- Returns
The time_of_expiration of this TableSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this TableSummary. The time the the table’s metadata was last updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this TableSummary.
- Return type
datetime