Class AccessConfig (1.41.0)

Version 1.41.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public final class AccessConfig extends GeneratedMessageV3 implements AccessConfigOrBuilder

An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Protobuf type google.cloud.compute.v1.AccessConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AccessConfig

Implements

AccessConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

EXTERNAL_IPV6_FIELD_NUMBER

public static final int EXTERNAL_IPV6_FIELD_NUMBER

Field Value
Type	Description
int

EXTERNAL_IPV6_PREFIX_LENGTH_FIELD_NUMBER

public static final int EXTERNAL_IPV6_PREFIX_LENGTH_FIELD_NUMBER

Field Value
Type	Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

NAT_I_P_FIELD_NUMBER

public static final int NAT_I_P_FIELD_NUMBER

Field Value
Type	Description
int

NETWORK_TIER_FIELD_NUMBER

public static final int NETWORK_TIER_FIELD_NUMBER

Field Value
Type	Description
int

PUBLIC_PTR_DOMAIN_NAME_FIELD_NUMBER

public static final int PUBLIC_PTR_DOMAIN_NAME_FIELD_NUMBER

Field Value
Type	Description
int

SET_PUBLIC_PTR_FIELD_NUMBER

public static final int SET_PUBLIC_PTR_FIELD_NUMBER

Field Value
Type	Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AccessConfig getDefaultInstance()

Returns
Type	Description
AccessConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AccessConfig.Builder newBuilder()

Returns
Type	Description
AccessConfig.Builder

newBuilder(AccessConfig prototype)

public static AccessConfig.Builder newBuilder(AccessConfig prototype)

Parameter
Name	Description
prototype	AccessConfig

Returns
Type	Description
AccessConfig.Builder

parseDelimitedFrom(InputStream input)

public static AccessConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AccessConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AccessConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AccessConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AccessConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AccessConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AccessConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AccessConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AccessConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AccessConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AccessConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AccessConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AccessConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AccessConfig> parser()

Returns
Type	Description
Parser<AccessConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public AccessConfig getDefaultInstanceForType()

Returns
Type	Description
AccessConfig

getExternalIpv6()

public String getExternalIpv6()

Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.

optional string external_ipv6 = 532703707;

Returns
Type	Description
String	The externalIpv6.

getExternalIpv6Bytes()

public ByteString getExternalIpv6Bytes()

Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.

optional string external_ipv6 = 532703707;

Returns
Type	Description
ByteString	The bytes for externalIpv6.

getExternalIpv6PrefixLength()

public int getExternalIpv6PrefixLength()

Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.

optional int32 external_ipv6_prefix_length = 425672143;

Returns
Type	Description
int	The externalIpv6PrefixLength.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

optional string kind = 3292052;

Returns
Type	Description
String	The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

optional string kind = 3292052;

Returns
Type	Description
ByteString	The bytes for kind.

getName()

public String getName()

The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.

optional string name = 3373707;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.

optional string name = 3373707;

Returns
Type	Description
ByteString	The bytes for name.

getNatIP()

public String getNatIP()

Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

optional string nat_i_p = 117634556;

Returns
Type	Description
String	The natIP.

getNatIPBytes()

public ByteString getNatIPBytes()

Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

optional string nat_i_p = 117634556;

Returns
Type	Description
ByteString	The bytes for natIP.

getNetworkTier()

public String getNetworkTier()

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
String	The networkTier.

getNetworkTierBytes()

public ByteString getNetworkTierBytes()

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
ByteString	The bytes for networkTier.

getParserForType()

public Parser<AccessConfig> getParserForType()

Returns
Type	Description
Parser<AccessConfig>

Overrides

GeneratedMessageV3.getParserForType()

getPublicPtrDomainName()

public String getPublicPtrDomainName()

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.

optional string public_ptr_domain_name = 316599167;

Returns
Type	Description
String	The publicPtrDomainName.

getPublicPtrDomainNameBytes()

public ByteString getPublicPtrDomainNameBytes()

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.

optional string public_ptr_domain_name = 316599167;

Returns
Type	Description
ByteString	The bytes for publicPtrDomainName.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSetPublicPtr()

public boolean getSetPublicPtr()

Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.

optional bool set_public_ptr = 523870229;

Returns
Type	Description
boolean	The setPublicPtr.

getType()

public String getType()

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
Type	Description
String	The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
Type	Description
ByteString	The bytes for type.

hasExternalIpv6()

public boolean hasExternalIpv6()

Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance's subnetwork.

optional string external_ipv6 = 532703707;

Returns
Type	Description
boolean	Whether the externalIpv6 field is set.

hasExternalIpv6PrefixLength()

public boolean hasExternalIpv6PrefixLength()

Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.

optional int32 external_ipv6_prefix_length = 425672143;

Returns
Type	Description
boolean	Whether the externalIpv6PrefixLength field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#accessConfig for access configs.

optional string kind = 3292052;

Returns
Type	Description
boolean	Whether the kind field is set.

hasName()

public boolean hasName()

The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.

optional string name = 3373707;

Returns
Type	Description
boolean	Whether the name field is set.

hasNatIP()

public boolean hasNatIP()

Applies to accessConfigs (IPv4) only. An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

optional string nat_i_p = 117634556;

Returns
Type	Description
boolean	Whether the natIP field is set.

hasNetworkTier()

public boolean hasNetworkTier()

This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP. Check the NetworkTier enum for the list of possible values.

optional string network_tier = 517397843;

Returns
Type	Description
boolean	Whether the networkTier field is set.

hasPublicPtrDomainName()

public boolean hasPublicPtrDomainName()

The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be createc for first IP in associated external IPv6 range.

optional string public_ptr_domain_name = 316599167;

Returns
Type	Description
boolean	Whether the publicPtrDomainName field is set.

hasSetPublicPtr()

public boolean hasSetPublicPtr()

Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.

optional bool set_public_ptr = 523870229;

Returns
Type	Description
boolean	Whether the setPublicPtr field is set.

hasType()

public boolean hasType()

The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
Type	Description
boolean	Whether the type field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public AccessConfig.Builder newBuilderForType()

Returns
Type	Description
AccessConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AccessConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AccessConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AccessConfig.Builder toBuilder()

Returns
Type	Description
AccessConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException