PrivateEndpointSummary¶

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

Bases: object

The summary metadata associated with the private endpoint.

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_tags`	Gets the defined_tags of this PrivateEndpointSummary.
`description`	Gets the description of this PrivateEndpointSummary.
`display_name`	[Required] Gets the display_name of this PrivateEndpointSummary.
`dns_zones`	Gets the dns_zones of this PrivateEndpointSummary.
`freeform_tags`	Gets the freeform_tags of this PrivateEndpointSummary.
`id`	[Required] Gets the id of this PrivateEndpointSummary.
`is_used_with_configuration_source_provider`	Gets the is_used_with_configuration_source_provider of this PrivateEndpointSummary.
`lifecycle_state`	Gets the lifecycle_state of this PrivateEndpointSummary.
`time_created`	Gets the time_created 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.
compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpointSummary.
display_name (str) – The value to assign to the display_name property of this PrivateEndpointSummary.
description (str) – The value to assign to the description property of this PrivateEndpointSummary.
vcn_id (str) – The value to assign to the vcn_id property of this PrivateEndpointSummary.
is_used_with_configuration_source_provider (bool) – The value to assign to the is_used_with_configuration_source_provider property of this PrivateEndpointSummary.
dns_zones (list[str]) – The value to assign to the dns_zones property of this PrivateEndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this PrivateEndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state 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.

compartment_id¶

[Required] Gets the compartment_id of this PrivateEndpointSummary. The OCID of the compartment containing this private endpoint.

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

defined_tags¶

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))

description¶

Gets the description of this PrivateEndpointSummary. Description of the private endpoint. Avoid entering confidential information.

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

display_name¶

[Required] Gets the display_name of this PrivateEndpointSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

dns_zones¶

Gets the dns_zones of this PrivateEndpointSummary. DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.

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

freeform_tags¶

Gets the freeform_tags of this PrivateEndpointSummary. Free-form tags associated with the resource. Each tag is a 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)

id¶

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

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

is_used_with_configuration_source_provider¶

Gets the is_used_with_configuration_source_provider of this PrivateEndpointSummary. When true, allows the private endpoint to be used with a configuration source provider.

Returns:	The is_used_with_configuration_source_provider of this PrivateEndpointSummary.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this PrivateEndpointSummary. The current lifecycle state of the private endpoint. Allowable values: - ACTIVE - CREATING - DELETING - DELETED - FAILED

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

time_created¶

Gets the time_created of this PrivateEndpointSummary. The date and time when the private endpoint was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

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

vcn_id¶

[Required] Gets the vcn_id of this PrivateEndpointSummary. The OCID of the VCN for the private endpoint.

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