PrivateEndpointSummary¶
- class oci.object_storage.models.PrivateEndpointSummary(**kwargs)¶
Bases:
objectTo use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Methods:
__init__(**kwargs)Initializes a new PrivateEndpointSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this PrivateEndpointSummary.
[Required] Gets the created_by of this PrivateEndpointSummary.
[Required] Gets the etag of this PrivateEndpointSummary.
[Required] Gets the fqdns of this PrivateEndpointSummary.
[Required] Gets the lifecycle_state of this PrivateEndpointSummary.
[Required] Gets the name of this PrivateEndpointSummary.
[Required] Gets the namespace of this PrivateEndpointSummary.
[Required] Gets the prefix of this PrivateEndpointSummary.
[Required] Gets the time_created of this PrivateEndpointSummary.
[Required] Gets the time_modified 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
name (str) – The value to assign to the name property of this PrivateEndpointSummary.
namespace (str) – The value to assign to the namespace property of this PrivateEndpointSummary.
compartment_id (str) – The value to assign to the compartment_id property of this PrivateEndpointSummary.
created_by (str) – The value to assign to the created_by property of this PrivateEndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this PrivateEndpointSummary.
time_modified (datetime) – The value to assign to the time_modified property of this PrivateEndpointSummary.
prefix (str) – The value to assign to the prefix property of this PrivateEndpointSummary.
fqdns (oci.object_storage.models.Fqdns) – The value to assign to the fqdns property of this PrivateEndpointSummary.
etag (str) – The value to assign to the etag property of this PrivateEndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PrivateEndpointSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this PrivateEndpointSummary. The compartment ID in which the Private Endpoint is authorized.
- Returns
The compartment_id of this PrivateEndpointSummary.
- Return type
str
- property created_by¶
[Required] Gets the created_by of this PrivateEndpointSummary. The OCID of the user who created the Private Endpoint.
- Returns
The created_by of this PrivateEndpointSummary.
- Return type
str
- property etag¶
[Required] Gets the etag of this PrivateEndpointSummary. The entity tag for the Private Endpoint.
- Returns
The etag of this PrivateEndpointSummary.
- Return type
str
- property fqdns¶
[Required] Gets the fqdns of this PrivateEndpointSummary.
- Returns
The fqdns of this PrivateEndpointSummary.
- Return type
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this PrivateEndpointSummary. The summaries of Private Endpoints’ lifecycle state.
- Returns
The lifecycle_state of this PrivateEndpointSummary.
- Return type
str
- property name¶
[Required] Gets the name of this PrivateEndpointSummary. The name given to the Private Endpoint. Avoid entering confidential information. Example: my-new-pe1
- Returns
The name of this PrivateEndpointSummary.
- Return type
str
- property namespace¶
[Required] Gets the namespace of this PrivateEndpointSummary. The Object Storage namespace with which the Private Endpoint is associated.
- Returns
The namespace of this PrivateEndpointSummary.
- Return type
str
- property prefix¶
[Required] Gets the prefix of this PrivateEndpointSummary. A prefix to use for the private endpoint. The customer VCN’s DNS records are updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. Example: If the prefix chosen is “abc”, then the endpointFqdn will be ‘abc.private.objectstorage.<region>.oraclecloud.com’
- Returns
The prefix of this PrivateEndpointSummary.
- Return type
str