DpEndpointFromPrivate

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

Bases: oci.data_connectivity.models.dp_endpoint.DpEndpoint

The endpoint details for a private endpoint.

Attributes

MODEL_TYPE_PRIVATE_END_POINT str(object=’’) -> str
MODEL_TYPE_PUBLIC_END_POINT str(object=’’) -> str
STATE_ACTIVE A constant which can be used with the state property of a DpEndpointFromPrivate.
STATE_INACTIVE A constant which can be used with the state property of a DpEndpointFromPrivate.
compartment_id Gets the compartment_id of this DpEndpointFromPrivate.
data_assets Gets the data_assets of this DpEndpoint.
dcms_endpoint_id [Required] Gets the dcms_endpoint_id of this DpEndpointFromPrivate.
description Gets the description of this DpEndpoint.
dns_proxy_ip Gets the dns_proxy_ip of this DpEndpointFromPrivate.
dns_zones Gets the dns_zones of this DpEndpointFromPrivate.
identifier Gets the identifier of this DpEndpoint.
key Gets the key of this DpEndpoint.
model_type [Required] Gets the model_type of this DpEndpoint.
model_version Gets the model_version of this DpEndpoint.
name Gets the name of this DpEndpoint.
object_status Gets the object_status of this DpEndpoint.
object_version Gets the object_version of this DpEndpoint.
parent_ref Gets the parent_ref of this DpEndpoint.
pe_id Gets the pe_id of this DpEndpointFromPrivate.
private_endpoint_ip Gets the private_endpoint_ip of this DpEndpointFromPrivate.
state Gets the state of this DpEndpointFromPrivate.

Methods

__init__(**kwargs) Initializes a new DpEndpointFromPrivate object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
MODEL_TYPE_PRIVATE_END_POINT = 'PRIVATE_END_POINT'
MODEL_TYPE_PUBLIC_END_POINT = 'PUBLIC_END_POINT'
STATE_ACTIVE = 'ACTIVE'

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

STATE_INACTIVE = 'INACTIVE'

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

__init__(**kwargs)

Initializes a new DpEndpointFromPrivate object with values from keyword arguments. The default value of the model_type attribute of this class is PRIVATE_END_POINT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • model_type (str) – The value to assign to the model_type property of this DpEndpointFromPrivate. Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • key (str) – The value to assign to the key property of this DpEndpointFromPrivate.
  • model_version (str) – The value to assign to the model_version property of this DpEndpointFromPrivate.
  • parent_ref (oci.data_connectivity.models.ParentReference) – The value to assign to the parent_ref property of this DpEndpointFromPrivate.
  • name (str) – The value to assign to the name property of this DpEndpointFromPrivate.
  • description (str) – The value to assign to the description property of this DpEndpointFromPrivate.
  • object_version (int) – The value to assign to the object_version property of this DpEndpointFromPrivate.
  • object_status (int) – The value to assign to the object_status property of this DpEndpointFromPrivate.
  • identifier (str) – The value to assign to the identifier property of this DpEndpointFromPrivate.
  • data_assets (list[oci.data_connectivity.models.DataAsset]) – The value to assign to the data_assets property of this DpEndpointFromPrivate.
  • dcms_endpoint_id (str) – The value to assign to the dcms_endpoint_id property of this DpEndpointFromPrivate.
  • pe_id (str) – The value to assign to the pe_id property of this DpEndpointFromPrivate.
  • compartment_id (str) – The value to assign to the compartment_id property of this DpEndpointFromPrivate.
  • dns_proxy_ip (str) – The value to assign to the dns_proxy_ip property of this DpEndpointFromPrivate.
  • private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this DpEndpointFromPrivate.
  • dns_zones (list[str]) – The value to assign to the dns_zones property of this DpEndpointFromPrivate.
  • state (str) – The value to assign to the state property of this DpEndpointFromPrivate. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id

Gets the compartment_id of this DpEndpointFromPrivate. The compartmentId of private endpoint resource.

Returns:The compartment_id of this DpEndpointFromPrivate.
Return type:str
data_assets

Gets the data_assets of this DpEndpoint. List of data assets which belongs to this endpoint

Returns:The data_assets of this DpEndpoint.
Return type:list[oci.data_connectivity.models.DataAsset]
dcms_endpoint_id

[Required] Gets the dcms_endpoint_id of this DpEndpointFromPrivate. The endpoint ID provided by control plane.

Returns:The dcms_endpoint_id of this DpEndpointFromPrivate.
Return type:str
description

Gets the description of this DpEndpoint. User-defined description for the endpoint.

Returns:The description of this DpEndpoint.
Return type:str
dns_proxy_ip

Gets the dns_proxy_ip of this DpEndpointFromPrivate. The IP address of dns proxy.

Returns:The dns_proxy_ip of this DpEndpointFromPrivate.
Return type:str
dns_zones

Gets the dns_zones of this DpEndpointFromPrivate. Array of dns zones to be use during private endpoint resolution.

Returns:The dns_zones of this DpEndpointFromPrivate.
Return type:list[str]
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

identifier

Gets the identifier of this DpEndpoint. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:The identifier of this DpEndpoint.
Return type:str
key

Gets the key of this DpEndpoint. Generated key that can be used in API calls to identify endpoint. On scenarios where reference to the endpoint is needed, a value can be passed in create.

Returns:The key of this DpEndpoint.
Return type:str
model_type

[Required] Gets the model_type of this DpEndpoint. The type of the endpoint.

Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The model_type of this DpEndpoint.
Return type:str
model_version

Gets the model_version of this DpEndpoint. The model version of an object.

Returns:The model_version of this DpEndpoint.
Return type:str
name

Gets the name of this DpEndpoint. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:The name of this DpEndpoint.
Return type:str
object_status

Gets the object_status of this DpEndpoint. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:The object_status of this DpEndpoint.
Return type:int
object_version

Gets the object_version of this DpEndpoint. The version of the object that is used to track changes in the object instance.

Returns:The object_version of this DpEndpoint.
Return type:int
parent_ref

Gets the parent_ref of this DpEndpoint.

Returns:The parent_ref of this DpEndpoint.
Return type:oci.data_connectivity.models.ParentReference
pe_id

Gets the pe_id of this DpEndpointFromPrivate. The ocid of private endpoint resource.

Returns:The pe_id of this DpEndpointFromPrivate.
Return type:str
private_endpoint_ip

Gets the private_endpoint_ip of this DpEndpointFromPrivate. The ocid of private endpoint resource.

Returns:The private_endpoint_ip of this DpEndpointFromPrivate.
Return type:str
state

Gets the state of this DpEndpointFromPrivate. Specifies the private endpoint state.

Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The state of this DpEndpointFromPrivate.
Return type:str