Catalog

class oci.data_catalog.models.Catalog(**kwargs)

Bases: object

A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a Catalog.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Catalog.
attached_catalog_private_endpoints Gets the attached_catalog_private_endpoints of this Catalog.
compartment_id [Required] Gets the compartment_id of this Catalog.
defined_tags Gets the defined_tags of this Catalog.
display_name Gets the display_name of this Catalog.
freeform_tags Gets the freeform_tags of this Catalog.
id [Required] Gets the id of this Catalog.
lifecycle_details Gets the lifecycle_details of this Catalog.
lifecycle_state Gets the lifecycle_state of this Catalog.
number_of_objects Gets the number_of_objects of this Catalog.
service_api_url Gets the service_api_url of this Catalog.
service_console_url Gets the service_console_url of this Catalog.
time_created Gets the time_created of this Catalog.
time_updated Gets the time_updated of this Catalog.

Methods

__init__(**kwargs) Initializes a new Catalog object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Catalog. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Catalog 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 Catalog.
  • display_name (str) – The value to assign to the display_name property of this Catalog.
  • compartment_id (str) – The value to assign to the compartment_id property of this Catalog.
  • time_created (datetime) – The value to assign to the time_created property of this Catalog.
  • time_updated (datetime) – The value to assign to the time_updated property of this Catalog.
  • service_api_url (str) – The value to assign to the service_api_url property of this Catalog.
  • service_console_url (str) – The value to assign to the service_console_url property of this Catalog.
  • number_of_objects (int) – The value to assign to the number_of_objects property of this Catalog.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Catalog. 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 Catalog.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Catalog.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Catalog.
  • attached_catalog_private_endpoints (list[str]) – The value to assign to the attached_catalog_private_endpoints property of this Catalog.
attached_catalog_private_endpoints

Gets the attached_catalog_private_endpoints of this Catalog. The list of private reverse connection endpoints attached to the catalog

Returns:The attached_catalog_private_endpoints of this Catalog.
Return type:list[str]
compartment_id

[Required] Gets the compartment_id of this Catalog. Compartment identifier.

Returns:The compartment_id of this Catalog.
Return type:str
defined_tags

Gets the defined_tags of this Catalog. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this Catalog.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this Catalog. Data catalog identifier, which can be renamed.

Returns:The display_name of this Catalog.
Return type:str
freeform_tags

Gets the freeform_tags of this Catalog. 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 Catalog.
Return type:dict(str, str)
id

[Required] Gets the id of this Catalog. OCID of the data catalog instance.

Returns:The id of this Catalog.
Return type:str
lifecycle_details

Gets the lifecycle_details of this Catalog. An message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in ‘Failed’ state.

Returns:The lifecycle_details of this Catalog.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Catalog. The current state of the data catalog resource.

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

Gets the number_of_objects of this Catalog. The number of data objects added to the data catalog. Please see the data catalog documentation for further information on how this is calculated.

Returns:The number_of_objects of this Catalog.
Return type:int
service_api_url

Gets the service_api_url of this Catalog. The REST front endpoint URL to the data catalog instance.

Returns:The service_api_url of this Catalog.
Return type:str
service_console_url

Gets the service_console_url of this Catalog. The console front endpoint URL to the data catalog instance.

Returns:The service_console_url of this Catalog.
Return type:str
time_created

Gets the time_created of this Catalog. The time the data catalog was created. An RFC3339 formatted datetime string.

Returns:The time_created of this Catalog.
Return type:datetime
time_updated

Gets the time_updated of this Catalog. The time the data catalog was updated. An RFC3339 formatted datetime string.

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