Endpoint

class oci.data_connectivity.models.Endpoint(**kwargs)

Bases: object

An Endpoint is an organizational construct to keep multiple data Connectivity Management solutions and their resources (pe-id, dnsProxyIp, dnsZones, and so on) separate from each other, helping you to stay organized. For example, you could have separate registries for development, testing, and production.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a Endpoint.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a Endpoint.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a Endpoint.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a Endpoint.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a Endpoint.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a Endpoint.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Endpoint.
compartment_id Gets the compartment_id of this Endpoint.
defined_tags Gets the defined_tags of this Endpoint.
description Gets the description of this Endpoint.
display_name [Required] Gets the display_name of this Endpoint.
dns_zones Gets the dns_zones of this Endpoint.
endpoint_size Gets the endpoint_size of this Endpoint.
freeform_tags Gets the freeform_tags of this Endpoint.
id [Required] Gets the id of this Endpoint.
lifecycle_state Gets the lifecycle_state of this Endpoint.
nsg_ids Gets the nsg_ids of this Endpoint.
state_message Gets the state_message of this Endpoint.
subnet_id [Required] Gets the subnet_id of this Endpoint.
time_created Gets the time_created of this Endpoint.
time_updated Gets the time_updated of this Endpoint.
vcn_id [Required] Gets the vcn_id of this Endpoint.

Methods

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

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new Endpoint object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • vcn_id (str) – The value to assign to the vcn_id property of this Endpoint.
  • subnet_id (str) – The value to assign to the subnet_id property of this Endpoint.
  • dns_zones (list[str]) – The value to assign to the dns_zones property of this Endpoint.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Endpoint.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Endpoint.
  • description (str) – The value to assign to the description property of this Endpoint.
  • display_name (str) – The value to assign to the display_name property of this Endpoint.
  • compartment_id (str) – The value to assign to the compartment_id property of this Endpoint.
  • time_created (datetime) – The value to assign to the time_created property of this Endpoint.
  • time_updated (datetime) – The value to assign to the time_updated property of this Endpoint.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Endpoint. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • state_message (str) – The value to assign to the state_message property of this Endpoint.
  • id (str) – The value to assign to the id property of this Endpoint.
  • endpoint_size (int) – The value to assign to the endpoint_size property of this Endpoint.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this Endpoint.
compartment_id

Gets the compartment_id of this Endpoint. Compartment Identifier

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

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

Returns:The defined_tags of this Endpoint.
Return type:dict(str, dict(str, object))
description

Gets the description of this Endpoint. Registry description

Returns:The description of this Endpoint.
Return type:str
display_name

[Required] Gets the display_name of this Endpoint. Data Connectivity Management Registry display name, registries can be renamed

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

Gets the dns_zones of this Endpoint. 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 Endpoint.
Return type:list[str]
endpoint_size

Gets the endpoint_size of this Endpoint. Endpoint size for reverse connection capacity.

Returns:The endpoint_size of this Endpoint.
Return type:int
freeform_tags

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

[Required] Gets the id of this Endpoint. Unique identifier that is immutable on creation

Returns:The id of this Endpoint.
Return type:str
lifecycle_state

Gets the lifecycle_state of this Endpoint. Lifecycle states for registries in Data Connectivity Management Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for

administrative reasons

DELETED - The resource has been deleted and isn’t available FAILED - The resource is in a failed state due to validation or other errors

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “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 Endpoint.
Return type:str
nsg_ids

Gets the nsg_ids of this Endpoint. List of NSGs to which the Private Endpoint VNIC must be added.

Returns:The nsg_ids of this Endpoint.
Return type:list[str]
state_message

Gets the state_message of this Endpoint. 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 state_message of this Endpoint.
Return type:str
subnet_id

[Required] Gets the subnet_id of this Endpoint. Subnet OCID for the customer connected network where databases for example reside.

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

Gets the time_created of this Endpoint. The time the Data Connectivity Management Registry was created. An RFC3339 formatted datetime string

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

Gets the time_updated of this Endpoint. The time the Data Connectivity Management Registry was updated. An RFC3339 formatted datetime string

Returns:The time_updated of this Endpoint.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this Endpoint. VCN OCID where the subnet resides.

Returns:The vcn_id of this Endpoint.
Return type:str