PrivateEndpointSummary¶

class oci.data_flow.models.PrivateEndpointSummary(**kwargs)¶

Bases: object

A Data Flow private endpoint object used in bulk listings.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary.
`compartment_id`	[Required] Gets the compartment_id of this PrivateEndpointSummary.
`defined_tags`	[Required] Gets the defined_tags of this PrivateEndpointSummary.
`display_name`	[Required] Gets the display_name of this PrivateEndpointSummary.
`dns_zones`	[Required] Gets the dns_zones of this PrivateEndpointSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this PrivateEndpointSummary.
`id`	[Required] Gets the id of this PrivateEndpointSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this PrivateEndpointSummary.
`max_host_count`	Gets the max_host_count of this PrivateEndpointSummary.
`nsg_ids`	Gets the nsg_ids of this PrivateEndpointSummary.
`owner_principal_id`	[Required] Gets the owner_principal_id of this PrivateEndpointSummary.
`owner_user_name`	Gets the owner_user_name of this PrivateEndpointSummary.
`scan_details`	Gets the scan_details of this PrivateEndpointSummary.
`security_attributes`	Gets the security_attributes of this PrivateEndpointSummary.
`subnet_id`	[Required] Gets the subnet_id of this PrivateEndpointSummary.
`time_created`	[Required] Gets the time_created of this PrivateEndpointSummary.
`time_updated`	[Required] Gets the time_updated of this PrivateEndpointSummary.

Methods:

__init__(**kwargs)

Initializes a new PrivateEndpointSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a PrivateEndpointSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new PrivateEndpointSummary 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 PrivateEndpointSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateEndpointSummary.
display_name (str) – The value to assign to the display_name property of this PrivateEndpointSummary.
dns_zones (list[str]) – The value to assign to the dns_zones property of this PrivateEndpointSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateEndpointSummary.
id (str) – The value to assign to the id property of this PrivateEndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PrivateEndpointSummary.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this PrivateEndpointSummary.
owner_user_name (str) – The value to assign to the owner_user_name property of this PrivateEndpointSummary.
scan_details (list[oci.data_flow.models.Scan]) – The value to assign to the scan_details property of this PrivateEndpointSummary.
subnet_id (str) – The value to assign to the subnet_id property of this PrivateEndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this PrivateEndpointSummary.
time_updated (datetime) – The value to assign to the time_updated property of this PrivateEndpointSummary.
security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this PrivateEndpointSummary.

property compartment_id¶

[Required] Gets the compartment_id of this PrivateEndpointSummary. The OCID of a compartment.

Returns: The compartment_id of this PrivateEndpointSummary.
Return type: str

property defined_tags¶

[Required] Gets the defined_tags of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: dict(str, dict(str, object))

property display_name¶

[Required] Gets the display_name of this PrivateEndpointSummary. A user-friendly name. It does not have to be unique. Avoid entering confidential information.

Returns: The display_name of this PrivateEndpointSummary.
Return type: str

property dns_zones¶

[Required] Gets the dns_zones of this PrivateEndpointSummary. An array of DNS zone names. Example: [ “app.examplecorp.com”, “app.examplecorp2.com” ]

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

property freeform_tags¶

[Required] Gets the freeform_tags of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this PrivateEndpointSummary. The OCID of a private endpoint.

Returns: The id of this PrivateEndpointSummary.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: str

property max_host_count¶

Gets the max_host_count of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: int

property nsg_ids¶

Gets the nsg_ids of this PrivateEndpointSummary. An array of network security group OCIDs.

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

property owner_principal_id¶

[Required] Gets the owner_principal_id of this PrivateEndpointSummary. The OCID of the user who created the resource.

Returns: The owner_principal_id of this PrivateEndpointSummary.
Return type: str

property owner_user_name¶

Gets the owner_user_name of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: str

property scan_details¶

Gets the scan_details of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: list[oci.data_flow.models.Scan]

property security_attributes¶

Gets the security_attributes of this PrivateEndpointSummary. 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 PrivateEndpointSummary.
Return type: dict(str, dict(str, object))

property subnet_id¶

[Required] Gets the subnet_id of this PrivateEndpointSummary. The OCID of a subnet.

Returns: The subnet_id of this PrivateEndpointSummary.
Return type: str

property time_created¶

[Required] Gets the time_created of this PrivateEndpointSummary. The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns: The time_created of this PrivateEndpointSummary.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this PrivateEndpointSummary. The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

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