Package com.oracle.bmc.core.model

Class NatGateway

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class NatGateway
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic.

    For more information, see NAT Gateway.

    To 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
    Note: Objects should always be created or deserialized using the NatGateway.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 NatGateway.Builder, which maintain a set of all explicitly set fields called NatGateway.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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the NAT gateway.
        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

      • 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

      • 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

      • getId

        public String getId()
        The OCID of the NAT gateway.
        Returns:
        the value

      • getBlockTraffic

        public Boolean getBlockTraffic()
        Whether the NAT gateway blocks traffic through it.

        The default is false.

        Example: true

        Returns:
        the value

      • getLifecycleState

        public NatGateway.LifecycleState getLifecycleState()
        The NAT gateway’s current state.
        Returns:
        the value

      • getNatIp

        public String getNatIp()
        The IP address associated with the NAT gateway.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the NAT gateway was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getVcnId

        public String getVcnId()
        The OCID of the VCN the NAT gateway belongs to.
        Returns:
        the value

      • getPublicIpId

        public String getPublicIpId()
        The OCID of the public IP address associated with the NAT gateway.
        Returns:
        the value

      • getRouteTableId

        public String getRouteTableId()
        The OCID of the route table used by the NAT gateway.

        If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.

        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