Package com.oracle.bmc.objectstorage.model

Class CreatePrivateEndpointDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CreatePrivateEndpointDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details to create a private endpoint
    Note: Objects should always be created or deserialized using the CreatePrivateEndpointDetails.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 CreatePrivateEndpointDetails.Builder, which maintain a set of all explicitly set fields called CreatePrivateEndpointDetails.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).

    • Method Detail

      • getName

        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

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The ID of the compartment in which to create the Private Endpoint.
        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the customer’s subnet where the private endpoint VNIC will reside.
        Returns:
        the value

      • getPrefix

        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..oraclecloud.com’

        Returns:
        the value

      • getAdditionalPrefixes

        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.

        Returns:
        the value

      • getPrivateEndpointIp

        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.

        Returns:
        the value

      • getNsgIds

        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.

        Returns:
        the value

      • getAccessTargets

        public List<AccessTargetDetails> getAccessTargets()
        A list of targets that can be accessed by the private endpoint.
        Returns:
        the value

      • getFreeformTags

        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”}

        Returns:
        the value

      • getDefinedTags

        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”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel