DbManagementPrivateEndpointSummary

class oci.database_management.models.DbManagementPrivateEndpointSummary(**kwargs)

Bases: object

The summary of a Database Management private endpoint.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_UPDATING

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

compartment_id

[Required] Gets the compartment_id of this DbManagementPrivateEndpointSummary.

defined_tags

Gets the defined_tags of this DbManagementPrivateEndpointSummary.

description

Gets the description of this DbManagementPrivateEndpointSummary.

freeform_tags

Gets the freeform_tags of this DbManagementPrivateEndpointSummary.

id

[Required] Gets the id of this DbManagementPrivateEndpointSummary.

lifecycle_state

Gets the lifecycle_state of this DbManagementPrivateEndpointSummary.

name

[Required] Gets the name of this DbManagementPrivateEndpointSummary.

security_attributes

Gets the security_attributes of this DbManagementPrivateEndpointSummary.

subnet_id

[Required] Gets the subnet_id of this DbManagementPrivateEndpointSummary.

system_tags

Gets the system_tags of this DbManagementPrivateEndpointSummary.

time_created

Gets the time_created of this DbManagementPrivateEndpointSummary.

vcn_id

[Required] Gets the vcn_id of this DbManagementPrivateEndpointSummary.

Methods:

__init__(**kwargs)

Initializes a new DbManagementPrivateEndpointSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DbManagementPrivateEndpointSummary 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 DbManagementPrivateEndpointSummary.

  • name (str) – The value to assign to the name property of this DbManagementPrivateEndpointSummary.

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

  • vcn_id (str) – The value to assign to the vcn_id property of this DbManagementPrivateEndpointSummary.

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DbManagementPrivateEndpointSummary. 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’.

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

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

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

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

property compartment_id

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

Returns

The compartment_id of this DbManagementPrivateEndpointSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DbManagementPrivateEndpointSummary. 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 DbManagementPrivateEndpointSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this DbManagementPrivateEndpointSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DbManagementPrivateEndpointSummary. 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 DbManagementPrivateEndpointSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this DbManagementPrivateEndpointSummary. The OCID of the Database Management private endpoint.

Returns

The id of this DbManagementPrivateEndpointSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this DbManagementPrivateEndpointSummary. The current lifecycle state of the 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 DbManagementPrivateEndpointSummary.

Return type

str

property name

[Required] Gets the name of this DbManagementPrivateEndpointSummary. The display name of the Database Management private endpoint.

Returns

The name of this DbManagementPrivateEndpointSummary.

Return type

str

property security_attributes

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

Return type

dict(str, dict(str, object))

property subnet_id

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

Returns

The subnet_id of this DbManagementPrivateEndpointSummary.

Return type

str

property system_tags

Gets the system_tags of this DbManagementPrivateEndpointSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DbManagementPrivateEndpointSummary.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this DbManagementPrivateEndpointSummary.

Return type

datetime

property vcn_id

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

Returns

The vcn_id of this DbManagementPrivateEndpointSummary.

Return type

str