PrivateEndpointSummary¶
-
class
oci.globally_distributed_database.models.PrivateEndpointSummary(**kwargs)¶ Bases:
objectPrivateEndpoint resource summary.
Methods
__init__(**kwargs)Initializes a new PrivateEndpointSummary object with values from keyword arguments. Attributes
compartment_id[Required] Gets the compartment_id of this PrivateEndpointSummary. defined_tagsGets the defined_tags of this PrivateEndpointSummary. descriptionGets the description of this PrivateEndpointSummary. display_name[Required] Gets the display_name of this PrivateEndpointSummary. freeform_tagsGets the freeform_tags of this PrivateEndpointSummary. id[Required] Gets the id of this PrivateEndpointSummary. lifecycle_state[Required] Gets the lifecycle_state of this PrivateEndpointSummary. lifecycle_state_detailsGets the lifecycle_state_details of this PrivateEndpointSummary. nsg_idsGets the nsg_ids of this PrivateEndpointSummary. subnet_id[Required] Gets the subnet_id of this PrivateEndpointSummary. system_tagsGets the system_tags of this PrivateEndpointSummary. time_created[Required] Gets the time_created of this PrivateEndpointSummary. time_updated[Required] Gets the time_updated of this PrivateEndpointSummary. vcn_id[Required] Gets the vcn_id of this PrivateEndpointSummary. -
__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: - id (str) – The value to assign to the id property of this PrivateEndpointSummary.
- description (str) – The value to assign to the description property of this PrivateEndpointSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpointSummary.
- subnet_id (str) – The value to assign to the subnet_id property of this PrivateEndpointSummary.
- vcn_id (str) – The value to assign to the vcn_id property of this PrivateEndpointSummary.
- display_name (str) – The value to assign to the display_name property of this PrivateEndpointSummary.
- nsg_ids (list[str]) – The value to assign to the nsg_ids 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.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateEndpointSummary.
- lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this PrivateEndpointSummary.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PrivateEndpointSummary.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PrivateEndpointSummary.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PrivateEndpointSummary.
-
compartment_id¶ [Required] Gets the compartment_id of this PrivateEndpointSummary. Identifier of the compartment where private endpoint exists.
Returns: The compartment_id of this PrivateEndpointSummary. Return type: str
Gets the defined_tags of this PrivateEndpointSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
Returns: The defined_tags of this PrivateEndpointSummary. Return type: dict(str, dict(str, object))
-
description¶ Gets the description of this PrivateEndpointSummary. PrivateEndpoint description.
Returns: The description of this PrivateEndpointSummary. Return type: str
-
display_name¶ [Required] Gets the display_name of this PrivateEndpointSummary. Private endpoint display name.
Returns: The display_name of this PrivateEndpointSummary. Return type: str
Gets the freeform_tags of this PrivateEndpointSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}
Returns: The freeform_tags of this PrivateEndpointSummary. Return type: dict(str, str)
-
id¶ [Required] Gets the id of this PrivateEndpointSummary. PrivateEndpoint identifier
Returns: The id of this PrivateEndpointSummary. Return type: str
-
lifecycle_state¶ [Required] Gets the lifecycle_state of this PrivateEndpointSummary. Lifecycle state of private endpoint.
Returns: The lifecycle_state of this PrivateEndpointSummary. Return type: str
-
lifecycle_state_details¶ Gets the lifecycle_state_details of this PrivateEndpointSummary. Detailed message for the lifecycle state.
Returns: The lifecycle_state_details of this PrivateEndpointSummary. Return type: str
-
nsg_ids¶ Gets the nsg_ids of this PrivateEndpointSummary. The OCIDs of the network security groups that the private endpoint belongs to.
Returns: The nsg_ids of this PrivateEndpointSummary. Return type: list[str]
-
subnet_id¶ [Required] Gets the subnet_id of this PrivateEndpointSummary. Identifier of the customer subnet against which private endpoint is created.
Returns: The subnet_id of this PrivateEndpointSummary. Return type: str
Gets the system_tags of this PrivateEndpointSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
Returns: The system_tags of this PrivateEndpointSummary. Return type: dict(str, dict(str, object))
-
time_created¶ [Required] Gets the time_created of this PrivateEndpointSummary. The time the the private endpoint was created. An RFC3339 formatted datetime string
Returns: The time_created of this PrivateEndpointSummary. Return type: datetime
-
time_updated¶ [Required] Gets the time_updated of this PrivateEndpointSummary. The time the private endpoint was last updated. An RFC3339 formatted datetime string
Returns: The time_updated of this PrivateEndpointSummary. Return type: datetime
-
vcn_id¶ [Required] Gets the vcn_id of this PrivateEndpointSummary. Identifier of the VCN in which subnet exists.
Returns: The vcn_id of this PrivateEndpointSummary. Return type: str
-