Index¶
- class oci.nosql.models.Index(**kwargs)¶
Bases:
objectInformation about an index.
Attributes:
A constant which can be used with the lifecycle_state property of a Index.
A constant which can be used with the lifecycle_state property of a Index.
A constant which can be used with the lifecycle_state property of a Index.
A constant which can be used with the lifecycle_state property of a Index.
A constant which can be used with the lifecycle_state property of a Index.
A constant which can be used with the lifecycle_state property of a Index.
Gets the compartment_id of this Index.
Gets the keys of this Index.
Gets the lifecycle_details of this Index.
Gets the lifecycle_state of this Index.
Gets the name of this Index.
Gets the table_id of this Index.
Gets the table_name of this Index.
Methods:
__init__(**kwargs)Initializes a new Index object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Index. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Index. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Index. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Index. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Index. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Index. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new Index object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
name (str) – The value to assign to the name property of this Index.
compartment_id (str) – The value to assign to the compartment_id property of this Index.
table_name (str) – The value to assign to the table_name property of this Index.
table_id (str) – The value to assign to the table_id property of this Index.
keys (list[oci.nosql.models.IndexKey]) – The value to assign to the keys property of this Index.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Index. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Index.
- property compartment_id¶
Gets the compartment_id of this Index. Compartment Identifier.
- Returns
The compartment_id of this Index.
- Return type
str
- property keys¶
Gets the keys of this Index. A set of keys for a secondary index.
- Returns
The keys of this Index.
- Return type
- property lifecycle_details¶
Gets the lifecycle_details of this Index. A message describing the current state in more detail.
- Returns
The lifecycle_details of this Index.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this Index. The state of an index.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Index.
- Return type
str
- property name¶
Gets the name of this Index. Index name.
- Returns
The name of this Index.
- Return type
str
- property table_id¶
Gets the table_id of this Index. the OCID of the table to which this index belongs.
- Returns
The table_id of this Index.
- Return type
str
- property table_name¶
Gets the table_name of this Index. The name of the table to which this index belongs.
- Returns
The table_name of this Index.
- Return type
str