Class PrivateEndpoint


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20180917")
    public final class PrivateEndpoint
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A private endpoint allowing Resource Manager to access nonpublic cloud resources.

    For more information about private endpoints, see Private Endpoint Management.
    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).

    • Method Detail

      • getId

        public String getId()
        The OCID of the private endpoint.
        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing this private endpoint.
        Returns:
        the value
      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value
      • getDescription

        public String getDescription()
        Description of the private endpoint.

        Avoid entering confidential information.

        Returns:
        the value
      • getVcnId

        public String getVcnId()
        The OCID of the VCN for the private endpoint.
        Returns:
        the value
      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet within the VCN for the private endpoint.
        Returns:
        the value
      • getSourceIps

        public List<String> getSourceIps()
        The source IP addresses that Resource Manager uses to connect to your network.

        Automatically assigned by Resource Manager.

        Returns:
        the value
      • getIsUsedWithConfigurationSourceProvider

        public Boolean getIsUsedWithConfigurationSourceProvider()
        When true, allows the private endpoint to be used with a configuration source provider.
        Returns:
        the value
      • getDnsZones

        public List<String> getDnsZones()
        DNS zones to use for accessing private Git servers.

        For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com

        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        The date and time at which the private endpoint was created.

        Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z

        Returns:
        the value
      • getLifecycleState

        public PrivateEndpoint.LifecycleState getLifecycleState()
        The current lifecycle state of the private endpoint.
        Returns:
        the value
      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 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