Class RouterStatusNatStatus (1.91.0)

public final class RouterStatusNatStatus extends GeneratedMessageV3 implements RouterStatusNatStatusOrBuilder

Status of a NAT contained in this router.

Protobuf type google.cloud.compute.v1.RouterStatusNatStatus

Static Fields

AUTO_ALLOCATED_NAT_IPS_FIELD_NUMBER

public static final int AUTO_ALLOCATED_NAT_IPS_FIELD_NUMBER
Field Value
Type Description
int

DRAIN_AUTO_ALLOCATED_NAT_IPS_FIELD_NUMBER

public static final int DRAIN_AUTO_ALLOCATED_NAT_IPS_FIELD_NUMBER
Field Value
Type Description
int

DRAIN_USER_ALLOCATED_NAT_IPS_FIELD_NUMBER

public static final int DRAIN_USER_ALLOCATED_NAT_IPS_FIELD_NUMBER
Field Value
Type Description
int

MIN_EXTRA_NAT_IPS_NEEDED_FIELD_NUMBER

public static final int MIN_EXTRA_NAT_IPS_NEEDED_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NUM_VM_ENDPOINTS_WITH_NAT_MAPPINGS_FIELD_NUMBER

public static final int NUM_VM_ENDPOINTS_WITH_NAT_MAPPINGS_FIELD_NUMBER
Field Value
Type Description
int

RULE_STATUS_FIELD_NUMBER

public static final int RULE_STATUS_FIELD_NUMBER
Field Value
Type Description
int

USER_ALLOCATED_NAT_IPS_FIELD_NUMBER

public static final int USER_ALLOCATED_NAT_IPS_FIELD_NUMBER
Field Value
Type Description
int

USER_ALLOCATED_NAT_IP_RESOURCES_FIELD_NUMBER

public static final int USER_ALLOCATED_NAT_IP_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RouterStatusNatStatus getDefaultInstance()
Returns
Type Description
RouterStatusNatStatus

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RouterStatusNatStatus.Builder newBuilder()
Returns
Type Description
RouterStatusNatStatus.Builder

newBuilder(RouterStatusNatStatus prototype)

public static RouterStatusNatStatus.Builder newBuilder(RouterStatusNatStatus prototype)
Parameter
Name Description
prototype RouterStatusNatStatus
Returns
Type Description
RouterStatusNatStatus.Builder

parseDelimitedFrom(InputStream input)

public static RouterStatusNatStatus parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RouterStatusNatStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RouterStatusNatStatus parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RouterStatusNatStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RouterStatusNatStatus parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RouterStatusNatStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RouterStatusNatStatus parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RouterStatusNatStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RouterStatusNatStatus parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RouterStatusNatStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RouterStatusNatStatus parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RouterStatusNatStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterStatusNatStatus
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RouterStatusNatStatus> parser()
Returns
Type Description
Parser<RouterStatusNatStatus>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoAllocatedNatIps(int index)

public String getAutoAllocatedNatIps(int index)

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

repeated string auto_allocated_nat_ips = 510794246;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The autoAllocatedNatIps at the given index.

getAutoAllocatedNatIpsBytes(int index)

public ByteString getAutoAllocatedNatIpsBytes(int index)

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

repeated string auto_allocated_nat_ips = 510794246;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the autoAllocatedNatIps at the given index.

getAutoAllocatedNatIpsCount()

public int getAutoAllocatedNatIpsCount()

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

repeated string auto_allocated_nat_ips = 510794246;

Returns
Type Description
int

The count of autoAllocatedNatIps.

getAutoAllocatedNatIpsList()

public ProtocolStringList getAutoAllocatedNatIpsList()

Output only. A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]

repeated string auto_allocated_nat_ips = 510794246;

Returns
Type Description
ProtocolStringList

A list containing the autoAllocatedNatIps.

getDefaultInstanceForType()

public RouterStatusNatStatus getDefaultInstanceForType()
Returns
Type Description
RouterStatusNatStatus

getDrainAutoAllocatedNatIps(int index)

public String getDrainAutoAllocatedNatIps(int index)

Output only. A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_auto_allocated_nat_ips = 309184557;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The drainAutoAllocatedNatIps at the given index.

getDrainAutoAllocatedNatIpsBytes(int index)

public ByteString getDrainAutoAllocatedNatIpsBytes(int index)

Output only. A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_auto_allocated_nat_ips = 309184557;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the drainAutoAllocatedNatIps at the given index.

getDrainAutoAllocatedNatIpsCount()

public int getDrainAutoAllocatedNatIpsCount()

Output only. A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_auto_allocated_nat_ips = 309184557;

Returns
Type Description
int

The count of drainAutoAllocatedNatIps.

getDrainAutoAllocatedNatIpsList()

public ProtocolStringList getDrainAutoAllocatedNatIpsList()

Output only. A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_auto_allocated_nat_ips = 309184557;

Returns
Type Description
ProtocolStringList

A list containing the drainAutoAllocatedNatIps.

getDrainUserAllocatedNatIps(int index)

public String getDrainUserAllocatedNatIps(int index)

Output only. A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_user_allocated_nat_ips = 305268553;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The drainUserAllocatedNatIps at the given index.

getDrainUserAllocatedNatIpsBytes(int index)

public ByteString getDrainUserAllocatedNatIpsBytes(int index)

Output only. A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_user_allocated_nat_ips = 305268553;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the drainUserAllocatedNatIps at the given index.

getDrainUserAllocatedNatIpsCount()

public int getDrainUserAllocatedNatIpsCount()

Output only. A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_user_allocated_nat_ips = 305268553;

Returns
Type Description
int

The count of drainUserAllocatedNatIps.

getDrainUserAllocatedNatIpsList()

public ProtocolStringList getDrainUserAllocatedNatIpsList()

Output only. A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.1", "179.12.26.133"].

repeated string drain_user_allocated_nat_ips = 305268553;

Returns
Type Description
ProtocolStringList

A list containing the drainUserAllocatedNatIps.

getMinExtraNatIpsNeeded()

public int getMinExtraNatIpsNeeded()

Output only. The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used.

optional int32 min_extra_nat_ips_needed = 365786338;

Returns
Type Description
int

The minExtraNatIpsNeeded.

getName()

public String getName()

Output only. Unique name of this NAT.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Unique name of this NAT.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getNumVmEndpointsWithNatMappings()

public int getNumVmEndpointsWithNatMappings()

Output only. Number of VM endpoints (i.e., Nics) that can use NAT.

optional int32 num_vm_endpoints_with_nat_mappings = 512367468;

Returns
Type Description
int

The numVmEndpointsWithNatMappings.

getParserForType()

public Parser<RouterStatusNatStatus> getParserForType()
Returns
Type Description
Parser<RouterStatusNatStatus>
Overrides

getRuleStatus(int index)

public RouterStatusNatStatusNatRuleStatus getRuleStatus(int index)

Status of rules in this NAT.

repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Parameter
Name Description
index int
Returns
Type Description
RouterStatusNatStatusNatRuleStatus

getRuleStatusCount()

public int getRuleStatusCount()

Status of rules in this NAT.

repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Returns
Type Description
int

getRuleStatusList()

public List<RouterStatusNatStatusNatRuleStatus> getRuleStatusList()

Status of rules in this NAT.

repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Returns
Type Description
List<RouterStatusNatStatusNatRuleStatus>

getRuleStatusOrBuilder(int index)

public RouterStatusNatStatusNatRuleStatusOrBuilder getRuleStatusOrBuilder(int index)

Status of rules in this NAT.

repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Parameter
Name Description
index int
Returns
Type Description
RouterStatusNatStatusNatRuleStatusOrBuilder

getRuleStatusOrBuilderList()

public List<? extends RouterStatusNatStatusNatRuleStatusOrBuilder> getRuleStatusOrBuilderList()

Status of rules in this NAT.

repeated .google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatus rule_status = 140223125;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.RouterStatusNatStatusNatRuleStatusOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserAllocatedNatIpResources(int index)

public String getUserAllocatedNatIpResources(int index)

Output only. A list of fully qualified URLs of reserved IP address resources.

repeated string user_allocated_nat_ip_resources = 212776151;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The userAllocatedNatIpResources at the given index.

getUserAllocatedNatIpResourcesBytes(int index)

public ByteString getUserAllocatedNatIpResourcesBytes(int index)

Output only. A list of fully qualified URLs of reserved IP address resources.

repeated string user_allocated_nat_ip_resources = 212776151;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the userAllocatedNatIpResources at the given index.

getUserAllocatedNatIpResourcesCount()

public int getUserAllocatedNatIpResourcesCount()

Output only. A list of fully qualified URLs of reserved IP address resources.

repeated string user_allocated_nat_ip_resources = 212776151;

Returns
Type Description
int

The count of userAllocatedNatIpResources.

getUserAllocatedNatIpResourcesList()

public ProtocolStringList getUserAllocatedNatIpResourcesList()

Output only. A list of fully qualified URLs of reserved IP address resources.

repeated string user_allocated_nat_ip_resources = 212776151;

Returns
Type Description
ProtocolStringList

A list containing the userAllocatedNatIpResources.

getUserAllocatedNatIps(int index)

public String getUserAllocatedNatIps(int index)

Output only. A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

repeated string user_allocated_nat_ips = 506878242;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The userAllocatedNatIps at the given index.

getUserAllocatedNatIpsBytes(int index)

public ByteString getUserAllocatedNatIpsBytes(int index)

Output only. A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

repeated string user_allocated_nat_ips = 506878242;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the userAllocatedNatIps at the given index.

getUserAllocatedNatIpsCount()

public int getUserAllocatedNatIpsCount()

Output only. A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

repeated string user_allocated_nat_ips = 506878242;

Returns
Type Description
int

The count of userAllocatedNatIps.

getUserAllocatedNatIpsList()

public ProtocolStringList getUserAllocatedNatIpsList()

Output only. A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.26.133".

repeated string user_allocated_nat_ips = 506878242;

Returns
Type Description
ProtocolStringList

A list containing the userAllocatedNatIps.

hasMinExtraNatIpsNeeded()

public boolean hasMinExtraNatIpsNeeded()

Output only. The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is not used.

optional int32 min_extra_nat_ips_needed = 365786338;

Returns
Type Description
boolean

Whether the minExtraNatIpsNeeded field is set.

hasName()

public boolean hasName()

Output only. Unique name of this NAT.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasNumVmEndpointsWithNatMappings()

public boolean hasNumVmEndpointsWithNatMappings()

Output only. Number of VM endpoints (i.e., Nics) that can use NAT.

optional int32 num_vm_endpoints_with_nat_mappings = 512367468;

Returns
Type Description
boolean

Whether the numVmEndpointsWithNatMappings field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RouterStatusNatStatus.Builder newBuilderForType()
Returns
Type Description
RouterStatusNatStatus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RouterStatusNatStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RouterStatusNatStatus.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RouterStatusNatStatus.Builder toBuilder()
Returns
Type Description
RouterStatusNatStatus.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException