PrivateEndpoint¶
- class oci.data_flow.models.PrivateEndpoint(**kwargs)¶
Bases:
objectA Data Flow private endpoint object.
Attributes:
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
A constant which can be used with the lifecycle_state property of a PrivateEndpoint.
[Required] Gets the compartment_id of this PrivateEndpoint.
[Required] Gets the defined_tags of this PrivateEndpoint.
Gets the description of this PrivateEndpoint.
[Required] Gets the display_name of this PrivateEndpoint.
[Required] Gets the dns_zones of this PrivateEndpoint.
[Required] Gets the freeform_tags of this PrivateEndpoint.
[Required] Gets the id of this PrivateEndpoint.
Gets the lifecycle_details of this PrivateEndpoint.
[Required] Gets the lifecycle_state of this PrivateEndpoint.
Gets the max_host_count of this PrivateEndpoint.
Gets the nsg_ids of this PrivateEndpoint.
[Required] Gets the owner_principal_id of this PrivateEndpoint.
Gets the owner_user_name of this PrivateEndpoint.
Gets the scan_details of this PrivateEndpoint.
Gets the security_attributes of this PrivateEndpoint.
[Required] Gets the subnet_id of this PrivateEndpoint.
[Required] Gets the time_created of this PrivateEndpoint.
[Required] Gets the time_updated of this PrivateEndpoint.
Methods:
__init__(**kwargs)Initializes a new PrivateEndpoint object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a PrivateEndpoint. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new PrivateEndpoint object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateEndpoint.
description (str) – The value to assign to the description property of this PrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this PrivateEndpoint.
dns_zones (list[str]) – The value to assign to the dns_zones property of this PrivateEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateEndpoint.
id (str) – The value to assign to the id property of this PrivateEndpoint.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this PrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateEndpoint. 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’.
max_host_count (int) – The value to assign to the max_host_count property of this PrivateEndpoint.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PrivateEndpoint.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this PrivateEndpoint.
owner_user_name (str) – The value to assign to the owner_user_name property of this PrivateEndpoint.
scan_details (list[oci.data_flow.models.Scan]) – The value to assign to the scan_details property of this PrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this PrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this PrivateEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this PrivateEndpoint.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this PrivateEndpoint.
- property compartment_id¶
[Required] Gets the compartment_id of this PrivateEndpoint. The OCID of a compartment.
- Returns
The compartment_id of this PrivateEndpoint.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this PrivateEndpoint. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this PrivateEndpoint.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this PrivateEndpoint. A user-friendly description. Avoid entering confidential information.
- Returns
The description of this PrivateEndpoint.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this PrivateEndpoint. A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Returns
The display_name of this PrivateEndpoint.
- Return type
str
- property dns_zones¶
[Required] Gets the dns_zones of this PrivateEndpoint. An array of DNS zone names. Example: [ “app.examplecorp.com”, “app.examplecorp2.com” ]
- Returns
The dns_zones of this PrivateEndpoint.
- Return type
list[str]
- property freeform_tags¶
[Required] Gets the freeform_tags of this PrivateEndpoint. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this PrivateEndpoint.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this PrivateEndpoint. The OCID of a private endpoint.
- Returns
The id of this PrivateEndpoint.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this PrivateEndpoint. The detailed messages about the lifecycle state.
- Returns
The lifecycle_details of this PrivateEndpoint.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this PrivateEndpoint. The current state of this private 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’.
- Returns
The lifecycle_state of this PrivateEndpoint.
- Return type
str
- property max_host_count¶
Gets the max_host_count of this PrivateEndpoint. The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
- Returns
The max_host_count of this PrivateEndpoint.
- Return type
int
- property nsg_ids¶
Gets the nsg_ids of this PrivateEndpoint. An array of network security group OCIDs.
- Returns
The nsg_ids of this PrivateEndpoint.
- Return type
list[str]
- property owner_principal_id¶
[Required] Gets the owner_principal_id of this PrivateEndpoint. The OCID of the user who created the resource.
- Returns
The owner_principal_id of this PrivateEndpoint.
- Return type
str
- property owner_user_name¶
Gets the owner_user_name of this PrivateEndpoint. The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
- Returns
The owner_user_name of this PrivateEndpoint.
- Return type
str
- property scan_details¶
Gets the scan_details of this PrivateEndpoint. An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: “scan1.oracle.com”, port: “1521”}, { fqdn: “scan2.oracle.com”, port: “1521” } ]
- Returns
The scan_details of this PrivateEndpoint.
- Return type
- property security_attributes¶
Gets the security_attributes of this PrivateEndpoint. Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}
- Returns
The security_attributes of this PrivateEndpoint.
- Return type
dict(str, dict(str, object))
- property subnet_id¶
[Required] Gets the subnet_id of this PrivateEndpoint. The OCID of a subnet.
- Returns
The subnet_id of this PrivateEndpoint.
- Return type
str