@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.cloud.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
NatGateway.Builder |
static class |
NatGateway.LifecycleState
The NAT gateway’s current state.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| 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,
String publicIpId,
String routeTableId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static NatGateway.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
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()
Simple key-value pair that is applied without any predefined name, type or scope.
|
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.
|
String |
getPublicIpId()
The OCID of
the public IP address associated with the NAT gateway.
|
String |
getRouteTableId()
The OCID of
the route table used by 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() |
NatGateway.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","blockTraffic","lifecycleState","natIp","timeCreated","vcnId","publicIpId","routeTableId"}) 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, String publicIpId, String routeTableId)
public static NatGateway.Builder builder()
Create a new builder.
public NatGateway.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment that contains the NAT gateway.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Boolean getBlockTraffic()
Whether the NAT gateway blocks traffic through it. The default is false.
Example: true
public NatGateway.LifecycleState getLifecycleState()
The NAT gateway’s current state.
public String getNatIp()
The IP address associated with the NAT gateway.
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
public String getVcnId()
The OCID of the VCN the NAT gateway belongs to.
public String getPublicIpId()
The OCID of the public IP address associated with the NAT gateway.
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.
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.