Metastore¶
- class oci.data_catalog.models.Metastore(**kwargs)¶
Bases:
objectA Data Catalog Metastore provides a centralized metastore repository for use by other OCI services.
Attributes:
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
A constant which can be used with the lifecycle_state property of a Metastore.
[Required] Gets the compartment_id of this Metastore.
[Required] Gets the default_external_table_location of this Metastore.
[Required] Gets the default_managed_table_location of this Metastore.
Gets the defined_tags of this Metastore.
Gets the display_name of this Metastore.
Gets the freeform_tags of this Metastore.
[Required] Gets the id of this Metastore.
Gets the lifecycle_details of this Metastore.
Gets the lifecycle_state of this Metastore.
Gets the locks of this Metastore.
Gets the system_tags of this Metastore.
Gets the time_created of this Metastore.
Gets the time_updated of this Metastore.
Methods:
__init__(**kwargs)Initializes a new Metastore object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_MOVING = 'MOVING'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “MOVING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Metastore. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new Metastore 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 Metastore.
display_name (str) – The value to assign to the display_name property of this Metastore.
compartment_id (str) – The value to assign to the compartment_id property of this Metastore.
time_created (datetime) – The value to assign to the time_created property of this Metastore.
time_updated (datetime) – The value to assign to the time_updated property of this Metastore.
default_managed_table_location (str) – The value to assign to the default_managed_table_location property of this Metastore.
default_external_table_location (str) – The value to assign to the default_external_table_location property of this Metastore.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Metastore. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘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 Metastore.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Metastore.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Metastore.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Metastore.
locks (list[oci.data_catalog.models.ResourceLock]) – The value to assign to the locks property of this Metastore.
- property compartment_id¶
[Required] Gets the compartment_id of this Metastore. OCID of the compartment which holds the metastore.
- Returns
The compartment_id of this Metastore.
- Return type
str
- property default_external_table_location¶
[Required] Gets the default_external_table_location of this Metastore. Location under which external tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
- Returns
The default_external_table_location of this Metastore.
- Return type
str
- property default_managed_table_location¶
[Required] Gets the default_managed_table_location of this Metastore. Location under which managed tables will be created by default. This references Object Storage using an HDFS URI format. Example: oci://bucket@namespace/sub-dir/
- Returns
The default_managed_table_location of this Metastore.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this Metastore. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns
The defined_tags of this Metastore.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this Metastore. Mutable name of the metastore.
- Returns
The display_name of this Metastore.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this Metastore. 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 Metastore.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Metastore. The metastore’s OCID.
- Returns
The id of this Metastore.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this Metastore. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
- Returns
The lifecycle_details of this Metastore.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this Metastore. The current state of the metastore.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Metastore.
- Return type
str
- property locks¶
Gets the locks of this Metastore. Locks associated with this resource.
- Returns
The locks of this Metastore.
- Return type
- property system_tags¶
Gets the system_tags of this Metastore. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns
The system_tags of this Metastore.
- Return type
dict(str, dict(str, object))