com.oracle.bmc.core.model

Class NatGateway

java.lang.Object

com.oracle.bmc.core.model.NatGateway

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class NatGateway
extends Object

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.

Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.

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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NatGateway.Builder
static class	NatGateway.LifecycleState The NAT gateway’s current state.

Constructor Summary

Constructors

Constructor and Description
NatGateway(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, Boolean blockTraffic, NatGateway.LifecycleState lifecycleState, String natIp, Date timeCreated, String vcnId) Deprecated.

Method Summary

Modifier and Type	Method and Description
static NatGateway.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
Boolean	getBlockTraffic() Whether the NAT gateway blocks traffic through it.
String	getCompartmentId() The OCID of the compartment that contains the NAT gateway.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the NAT gateway.
NatGateway.LifecycleState	getLifecycleState() The NAT gateway’s current state.
String	getNatIp() The IP address associated with the NAT gateway.
Date	getTimeCreated() The date and time the NAT gateway was created, in the format defined by RFC3339.
String	getVcnId() The OCID of the VCN the NAT gateway belongs to.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NatGateway

@ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","blockTraffic","lifecycleState","natIp","timeCreated","vcnId"})
 @Deprecated
public NatGateway(String compartmentId,
                                                                                                                                                                                             Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                             String displayName,
                                                                                                                                                                                             Map<String,String> freeformTags,
                                                                                                                                                                                             String id,
                                                                                                                                                                                             Boolean blockTraffic,
                                                                                                                                                                                             NatGateway.LifecycleState lifecycleState,
                                                                                                                                                                                             String natIp,
                                                                                                                                                                                             Date timeCreated,
                                                                                                                                                                                             String vcnId)

Deprecated.

Method Detail

builder

public static NatGateway.Builder builder()

Create a new builder.

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the NAT gateway.

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\"}}

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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\"}

getId

public String getId()

The OCID of the NAT gateway.

getBlockTraffic

public Boolean getBlockTraffic()

Whether the NAT gateway blocks traffic through it. The default is false.

Example: true

getLifecycleState

public NatGateway.LifecycleState getLifecycleState()

The NAT gateway’s current state.

getNatIp

public String getNatIp()

The IP address associated with the NAT gateway.

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

getVcnId

public String getVcnId()

The OCID of the VCN the NAT gateway belongs to.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object