OdaPrivateEndpoint

class oci.oda.models.OdaPrivateEndpoint(**kwargs)

Bases: object

A private endpoint allows Digital Assistant Instance to access resources in a customer’s virtual cloud network (VCN).

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a OdaPrivateEndpoint.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a OdaPrivateEndpoint.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a OdaPrivateEndpoint.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a OdaPrivateEndpoint.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a OdaPrivateEndpoint.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a OdaPrivateEndpoint.

compartment_id

[Required] Gets the compartment_id of this OdaPrivateEndpoint.

defined_tags

Gets the defined_tags of this OdaPrivateEndpoint.

description

Gets the description of this OdaPrivateEndpoint.

display_name

[Required] Gets the display_name of this OdaPrivateEndpoint.

freeform_tags

Gets the freeform_tags of this OdaPrivateEndpoint.

id

[Required] Gets the id of this OdaPrivateEndpoint.

lifecycle_state

Gets the lifecycle_state of this OdaPrivateEndpoint.

nsg_ids

Gets the nsg_ids of this OdaPrivateEndpoint.

security_attributes

Gets the security_attributes of this OdaPrivateEndpoint.

subnet_id

[Required] Gets the subnet_id of this OdaPrivateEndpoint.

time_created

Gets the time_created of this OdaPrivateEndpoint.

time_updated

Gets the time_updated of this OdaPrivateEndpoint.

Methods:

__init__(**kwargs)

Initializes a new OdaPrivateEndpoint object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this OdaPrivateEndpoint.

  • display_name (str) – The value to assign to the display_name property of this OdaPrivateEndpoint.

  • description (str) – The value to assign to the description property of this OdaPrivateEndpoint.

  • compartment_id (str) – The value to assign to the compartment_id property of this OdaPrivateEndpoint.

  • time_created (datetime) – The value to assign to the time_created property of this OdaPrivateEndpoint.

  • time_updated (datetime) – The value to assign to the time_updated property of this OdaPrivateEndpoint.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OdaPrivateEndpoint. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • subnet_id (str) – The value to assign to the subnet_id property of this OdaPrivateEndpoint.

  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this OdaPrivateEndpoint.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this OdaPrivateEndpoint.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OdaPrivateEndpoint.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OdaPrivateEndpoint.

property compartment_id

[Required] Gets the compartment_id of this OdaPrivateEndpoint. The OCID of the compartment that the ODA private endpoint belongs to.

Returns

The compartment_id of this OdaPrivateEndpoint.

Return type

str

property defined_tags

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

Returns

The defined_tags of this OdaPrivateEndpoint.

Return type

dict(str, dict(str, object))

property description

Gets the description of this OdaPrivateEndpoint. Description of the ODA private endpoint.

Returns

The description of this OdaPrivateEndpoint.

Return type

str

property display_name

[Required] Gets the display_name of this OdaPrivateEndpoint. User-defined name for the ODA private endpoint. Avoid entering confidential information. You can change this value.

Returns

The display_name of this OdaPrivateEndpoint.

Return type

str

property freeform_tags

Gets the freeform_tags of this OdaPrivateEndpoint. Simple key-value pair that is applied without any predefined name, type, or scope. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this OdaPrivateEndpoint.

Return type

dict(str, str)

property id

[Required] Gets the id of this OdaPrivateEndpoint. The OCID that was assigned when the ODA private endpoint was created.

Returns

The id of this OdaPrivateEndpoint.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this OdaPrivateEndpoint. The current state of the ODA private endpoint.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 OdaPrivateEndpoint.

Return type

str

property nsg_ids

Gets the nsg_ids of this OdaPrivateEndpoint. List of OCIDs of network security groups

Returns

The nsg_ids of this OdaPrivateEndpoint.

Return type

list[str]

property security_attributes

Gets the security_attributes of this OdaPrivateEndpoint. 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 OdaPrivateEndpoint.

Return type

dict(str, dict(str, object))

property subnet_id

[Required] Gets the subnet_id of this OdaPrivateEndpoint. The OCID of the subnet that the private endpoint belongs to.

Returns

The subnet_id of this OdaPrivateEndpoint.

Return type

str

property time_created

Gets the time_created of this OdaPrivateEndpoint. When the resource was created. A date-time string as described in RFC 3339, section 14.29.

Returns

The time_created of this OdaPrivateEndpoint.

Return type

datetime

property time_updated

Gets the time_updated of this OdaPrivateEndpoint. When the resource was last updated. A date-time string as described in RFC 3339, section 14.29.

Returns

The time_updated of this OdaPrivateEndpoint.

Return type

datetime