@Generated(value="OracleSDKGenerator",
comments="API Version: 20160918")
public final class PrivateEndpoint
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A private endpoint makes your service accessible through a private IP in the customer’s private
network. A private endpoint has a name and is associated with a namespace and a single
compartment.
Note: Objects should always be created or deserialized using the PrivateEndpoint.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the PrivateEndpoint.Builder, which maintain a
set of all explicitly set fields called PrivateEndpoint.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
PrivateEndpoint.Builder |
static class |
PrivateEndpoint.LifecycleState
The Private Endpoint’s lifecycle state.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
PrivateEndpoint(String name,
String namespace,
String compartmentId,
String createdBy,
Date timeCreated,
Date timeModified,
String subnetId,
String privateEndpointIp,
String prefix,
List<String> additionalPrefixes,
List<String> nsgIds,
Fqdns fqdns,
String etag,
PrivateEndpoint.LifecycleState lifecycleState,
List<AccessTargetDetails> accessTargets,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
String id)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static PrivateEndpoint.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<AccessTargetDetails> |
getAccessTargets()
A list of targets that can be accessed by the private endpoint.
|
List<String> |
getAdditionalPrefixes()
A list of additional prefix that you can provide along with any other prefix.
|
String |
getCompartmentId()
The compartment which is associated with the Private Endpoint.
|
String |
getCreatedBy()
The OCID of the
user who created the Private Endpoint.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getEtag()
The entity tag (ETag) for the Private Endpoint.
|
Fqdns |
getFqdns() |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the
PrivateEndpoint.
|
PrivateEndpoint.LifecycleState |
getLifecycleState()
The Private Endpoint’s lifecycle state.
|
String |
getName()
This name associated with the endpoint.
|
String |
getNamespace()
The Object Storage namespace associated with the private enpoint.
|
List<String> |
getNsgIds()
A list of the OCIDs of the network security groups (NSGs) to add the private endpoint’s VNIC
to.
|
String |
getPrefix()
A prefix to use for the private endpoint.
|
String |
getPrivateEndpointIp()
The private IP address to assign to this private endpoint.
|
String |
getSubnetId()
The OCID of the customer’s subnet where the private endpoint VNIC will reside.
|
Date |
getTimeCreated()
The date and time the Private Endpoint was created, as described in RFC
2616.
|
Date |
getTimeModified()
The date and time the Private Endpoint was updated, as described in RFC
2616.
|
int |
hashCode() |
PrivateEndpoint.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"name","namespace","compartmentId","createdBy","timeCreated","timeModified","subnetId","privateEndpointIp","prefix","additionalPrefixes","nsgIds","fqdns","etag","lifecycleState","accessTargets","freeformTags","definedTags","id"}) public PrivateEndpoint(String name, String namespace, String compartmentId, String createdBy, Date timeCreated, Date timeModified, String subnetId, String privateEndpointIp, String prefix, List<String> additionalPrefixes, List<String> nsgIds, Fqdns fqdns, String etag, PrivateEndpoint.LifecycleState lifecycleState, List<AccessTargetDetails> accessTargets, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String id)
public static PrivateEndpoint.Builder builder()
Create a new builder.
public PrivateEndpoint.Builder toBuilder()
public String getName()
This name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Example: my-new-private-endpoint1
public String getNamespace()
The Object Storage namespace associated with the private enpoint.
public String getCompartmentId()
The compartment which is associated with the Private Endpoint.
public String getCreatedBy()
The OCID of the user who created the Private Endpoint.
public Date getTimeCreated()
The date and time the Private Endpoint was created, as described in RFC 2616.
public Date getTimeModified()
The date and time the Private Endpoint was updated, as described in RFC 2616.
public String getSubnetId()
The OCID of the customer’s subnet where the private endpoint VNIC will reside.
public String getPrivateEndpointIp()
The private IP address to assign to this private endpoint. If you provide a value, it must be an available IP address in the customer’s subnet. If it’s not available, an error is returned.
If you do not provide a value, an available IP address in the subnet is automatically chosen.
public String getPrefix()
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.
public List<String> getAdditionalPrefixes()
A list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn’s are added to the customer VCN’s DNS record.
public List<String> getNsgIds()
A list of the OCIDs of the network security groups (NSGs) to add the private endpoint’s VNIC
to. For more information about NSGs, see NetworkSecurityGroup.
public Fqdns getFqdns()
public String getEtag()
The entity tag (ETag) for the Private Endpoint.
public PrivateEndpoint.LifecycleState getLifecycleState()
The Private Endpoint’s lifecycle state.
public List<AccessTargetDetails> getAccessTargets()
A list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint.
public Map<String,String> getFreeformTags()
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"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
information, see Resource
Tags. Example:
{"Operations": {"CostCenter": "42"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.