DpEndpointFromPrivateDetails

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

Bases: oci.data_connectivity.models.dp_endpoint_details.DpEndpointDetails

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 DpEndpointFromPrivateDetails.
STATE_INACTIVE A constant which can be used with the state property of a DpEndpointFromPrivateDetails.
compartment_id Gets the compartment_id of this DpEndpointFromPrivateDetails.
data_assets Gets the data_assets of this DpEndpointDetails.
dcms_endpoint_id [Required] Gets the dcms_endpoint_id of this DpEndpointFromPrivateDetails.
description Gets the description of this DpEndpointDetails.
dns_proxy_ip Gets the dns_proxy_ip of this DpEndpointFromPrivateDetails.
dns_zones Gets the dns_zones of this DpEndpointFromPrivateDetails.
identifier Gets the identifier of this DpEndpointDetails.
key Gets the key of this DpEndpointDetails.
model_type [Required] Gets the model_type of this DpEndpointDetails.
model_version Gets the model_version of this DpEndpointDetails.
name Gets the name of this DpEndpointDetails.
object_status Gets the object_status of this DpEndpointDetails.
object_version Gets the object_version of this DpEndpointDetails.
parent_ref Gets the parent_ref of this DpEndpointDetails.
pe_id Gets the pe_id of this DpEndpointFromPrivateDetails.
private_endpoint_ip Gets the private_endpoint_ip of this DpEndpointFromPrivateDetails.
state Gets the state of this DpEndpointFromPrivateDetails.

Methods

__init__(**kwargs) Initializes a new DpEndpointFromPrivateDetails 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 DpEndpointFromPrivateDetails. This constant has a value of “ACTIVE”

STATE_INACTIVE = 'INACTIVE'

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

__init__(**kwargs)

Initializes a new DpEndpointFromPrivateDetails 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 DpEndpointFromPrivateDetails. Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”
  • key (str) – The value to assign to the key property of this DpEndpointFromPrivateDetails.
  • model_version (str) – The value to assign to the model_version property of this DpEndpointFromPrivateDetails.
  • parent_ref (oci.data_connectivity.models.ParentReference) – The value to assign to the parent_ref property of this DpEndpointFromPrivateDetails.
  • name (str) – The value to assign to the name property of this DpEndpointFromPrivateDetails.
  • description (str) – The value to assign to the description property of this DpEndpointFromPrivateDetails.
  • object_version (int) – The value to assign to the object_version property of this DpEndpointFromPrivateDetails.
  • object_status (int) – The value to assign to the object_status property of this DpEndpointFromPrivateDetails.
  • identifier (str) – The value to assign to the identifier property of this DpEndpointFromPrivateDetails.
  • data_assets (list[oci.data_connectivity.models.DataAsset]) – The value to assign to the data_assets property of this DpEndpointFromPrivateDetails.
  • dcms_endpoint_id (str) – The value to assign to the dcms_endpoint_id property of this DpEndpointFromPrivateDetails.
  • pe_id (str) – The value to assign to the pe_id property of this DpEndpointFromPrivateDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this DpEndpointFromPrivateDetails.
  • dns_proxy_ip (str) – The value to assign to the dns_proxy_ip property of this DpEndpointFromPrivateDetails.
  • private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this DpEndpointFromPrivateDetails.
  • dns_zones (list[str]) – The value to assign to the dns_zones property of this DpEndpointFromPrivateDetails.
  • state (str) – The value to assign to the state property of this DpEndpointFromPrivateDetails. Allowed values for this property are: “ACTIVE”, “INACTIVE”
compartment_id

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

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

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

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

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

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

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

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

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

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

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

Returns:The dns_zones of this DpEndpointFromPrivateDetails.
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 DpEndpointDetails. 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 DpEndpointDetails.
Return type:str
key

Gets the key of this DpEndpointDetails. 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 DpEndpointDetails.
Return type:str
model_type

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

Allowed values for this property are: “PRIVATE_END_POINT”, “PUBLIC_END_POINT”

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

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

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

Gets the name of this DpEndpointDetails. 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 DpEndpointDetails.
Return type:str
object_status

Gets the object_status of this DpEndpointDetails. 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 DpEndpointDetails.
Return type:int
object_version

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

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

Gets the parent_ref of this DpEndpointDetails.

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

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

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

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

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

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

Allowed values for this property are: “ACTIVE”, “INACTIVE”

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