CatalogPrivateEndpoint

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

Bases: object

A private network reverse connection creates a connection from service to customer subnet over a private network.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a CatalogPrivateEndpoint.
attached_catalogs Gets the attached_catalogs of this CatalogPrivateEndpoint.
compartment_id [Required] Gets the compartment_id of this CatalogPrivateEndpoint.
defined_tags Gets the defined_tags of this CatalogPrivateEndpoint.
display_name Gets the display_name of this CatalogPrivateEndpoint.
dns_zones [Required] Gets the dns_zones of this CatalogPrivateEndpoint.
freeform_tags Gets the freeform_tags of this CatalogPrivateEndpoint.
id [Required] Gets the id of this CatalogPrivateEndpoint.
lifecycle_details Gets the lifecycle_details of this CatalogPrivateEndpoint.
lifecycle_state Gets the lifecycle_state of this CatalogPrivateEndpoint.
subnet_id [Required] Gets the subnet_id of this CatalogPrivateEndpoint.
time_created Gets the time_created of this CatalogPrivateEndpoint.
time_updated Gets the time_updated of this CatalogPrivateEndpoint.

Methods

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

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new CatalogPrivateEndpoint 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 CatalogPrivateEndpoint.
  • compartment_id (str) – The value to assign to the compartment_id property of this CatalogPrivateEndpoint.
  • subnet_id (str) – The value to assign to the subnet_id property of this CatalogPrivateEndpoint.
  • display_name (str) – The value to assign to the display_name property of this CatalogPrivateEndpoint.
  • dns_zones (list[str]) – The value to assign to the dns_zones property of this CatalogPrivateEndpoint.
  • time_created (datetime) – The value to assign to the time_created property of this CatalogPrivateEndpoint.
  • time_updated (datetime) – The value to assign to the time_updated property of this CatalogPrivateEndpoint.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CatalogPrivateEndpoint.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CatalogPrivateEndpoint.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CatalogPrivateEndpoint. 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 CatalogPrivateEndpoint.
  • attached_catalogs (list[str]) – The value to assign to the attached_catalogs property of this CatalogPrivateEndpoint.
attached_catalogs

Gets the attached_catalogs of this CatalogPrivateEndpoint. The list of catalogs using the private reverse connection endpoint

Returns:The attached_catalogs of this CatalogPrivateEndpoint.
Return type:list[str]
compartment_id

[Required] Gets the compartment_id of this CatalogPrivateEndpoint. Compartment Identifier.

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

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

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

Gets the display_name of this CatalogPrivateEndpoint. Private Reverse Connection Endpoint display name

Returns:The display_name of this CatalogPrivateEndpoint.
Return type:str
dns_zones

[Required] Gets the dns_zones of this CatalogPrivateEndpoint. List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com

Returns:The dns_zones of this CatalogPrivateEndpoint.
Return type:list[str]
freeform_tags

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

[Required] Gets the id of this CatalogPrivateEndpoint. Unique identifier that is immutable

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

Gets the lifecycle_details of this CatalogPrivateEndpoint. 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 CatalogPrivateEndpoint.
Return type:str
lifecycle_state

Gets the lifecycle_state of this CatalogPrivateEndpoint. The current state of the private endpoint 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 CatalogPrivateEndpoint.
Return type:str
subnet_id

[Required] Gets the subnet_id of this CatalogPrivateEndpoint. Subnet Identifier

Returns:The subnet_id of this CatalogPrivateEndpoint.
Return type:str
time_created

Gets the time_created of this CatalogPrivateEndpoint. The time the private endpoint was created. An RFC3339 formatted datetime string.

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

Gets the time_updated of this CatalogPrivateEndpoint. The time the private endpoint was updated. An RFC3339 formatted datetime string.

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