DataSafePrivateEndpointSummary

class oci.data_safe.models.DataSafePrivateEndpointSummary(**kwargs)

Bases: object

Summary of a Data Safe private endpoint.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
LIFECYCLE_STATE_NA A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a DataSafePrivateEndpointSummary.
compartment_id [Required] Gets the compartment_id of this DataSafePrivateEndpointSummary.
description Gets the description of this DataSafePrivateEndpointSummary.
display_name [Required] Gets the display_name of this DataSafePrivateEndpointSummary.
id [Required] Gets the id of this DataSafePrivateEndpointSummary.
lifecycle_state Gets the lifecycle_state of this DataSafePrivateEndpointSummary.
private_endpoint_id [Required] Gets the private_endpoint_id of this DataSafePrivateEndpointSummary.
subnet_id [Required] Gets the subnet_id of this DataSafePrivateEndpointSummary.
time_created Gets the time_created of this DataSafePrivateEndpointSummary.
vcn_id [Required] Gets the vcn_id of this DataSafePrivateEndpointSummary.

Methods

__init__(**kwargs) Initializes a new DataSafePrivateEndpointSummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_NA = 'NA'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DataSafePrivateEndpointSummary 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 DataSafePrivateEndpointSummary.
  • display_name (str) – The value to assign to the display_name property of this DataSafePrivateEndpointSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this DataSafePrivateEndpointSummary.
  • vcn_id (str) – The value to assign to the vcn_id property of this DataSafePrivateEndpointSummary.
  • subnet_id (str) – The value to assign to the subnet_id property of this DataSafePrivateEndpointSummary.
  • private_endpoint_id (str) – The value to assign to the private_endpoint_id property of this DataSafePrivateEndpointSummary.
  • description (str) – The value to assign to the description property of this DataSafePrivateEndpointSummary.
  • time_created (datetime) – The value to assign to the time_created property of this DataSafePrivateEndpointSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataSafePrivateEndpointSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id

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

Returns:The compartment_id of this DataSafePrivateEndpointSummary.
Return type:str
description

Gets the description of this DataSafePrivateEndpointSummary. The description of the private endpoint.

Returns:The description of this DataSafePrivateEndpointSummary.
Return type:str
display_name

[Required] Gets the display_name of this DataSafePrivateEndpointSummary. The display name of the private endpoint.

Returns:The display_name of this DataSafePrivateEndpointSummary.
Return type:str
id

[Required] Gets the id of this DataSafePrivateEndpointSummary. The OCID of the Data Safe private endpoint.

Returns:The id of this DataSafePrivateEndpointSummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this DataSafePrivateEndpointSummary. The current state of the private endpoint.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this DataSafePrivateEndpointSummary.
Return type:str
private_endpoint_id

[Required] Gets the private_endpoint_id of this DataSafePrivateEndpointSummary. The OCID of the private endpoint.

Returns:The private_endpoint_id of this DataSafePrivateEndpointSummary.
Return type:str
subnet_id

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

Returns:The subnet_id of this DataSafePrivateEndpointSummary.
Return type:str
time_created

Gets the time_created of this DataSafePrivateEndpointSummary. The date and time the private endpoint was created, in the format defined by RFC3339.

Returns:The time_created of this DataSafePrivateEndpointSummary.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this DataSafePrivateEndpointSummary. The OCID of the VCN.

Returns:The vcn_id of this DataSafePrivateEndpointSummary.
Return type:str