Class AccessConfig.Builder (1.27.0)

public static final class AccessConfig.Builder extends GeneratedMessageV3.Builder<AccessConfig.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AccessConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AccessConfig.Builder
Overrides

build()

public AccessConfig build()
Returns
TypeDescription
AccessConfig

buildPartial()

public AccessConfig buildPartial()
Returns
TypeDescription
AccessConfig

clear()

public AccessConfig.Builder clear()
Returns
TypeDescription
AccessConfig.Builder
Overrides

clearExternalIpv6()

public AccessConfig.Builder clearExternalIpv6()

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
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearExternalIpv6PrefixLength()

public AccessConfig.Builder clearExternalIpv6PrefixLength()

The prefix length of the external IPv6 range.

optional int32 external_ipv6_prefix_length = 425672143;

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AccessConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AccessConfig.Builder
Overrides

clearKind()

public AccessConfig.Builder clearKind()

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

optional string kind = 3292052;

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearName()

public AccessConfig.Builder clearName()

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

optional string name = 3373707;

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearNatIP()

public AccessConfig.Builder clearNatIP()

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
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearNetworkTier()

public AccessConfig.Builder clearNetworkTier()

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
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AccessConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AccessConfig.Builder
Overrides

clearPublicPtrDomainName()

public AccessConfig.Builder clearPublicPtrDomainName()

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
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearSetPublicPtr()

public AccessConfig.Builder clearSetPublicPtr()

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
TypeDescription
AccessConfig.Builder

This builder for chaining.

clearType()

public AccessConfig.Builder clearType()

The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

clone()

public AccessConfig.Builder clone()
Returns
TypeDescription
AccessConfig.Builder
Overrides

getDefaultInstanceForType()

public AccessConfig getDefaultInstanceForType()
Returns
TypeDescription
AccessConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExternalIpv6()

public String getExternalIpv6()

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
TypeDescription
String

The externalIpv6.

getExternalIpv6Bytes()

public ByteString getExternalIpv6Bytes()

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
TypeDescription
ByteString

The bytes for externalIpv6.

getExternalIpv6PrefixLength()

public int getExternalIpv6PrefixLength()

The prefix length of the external IPv6 range.

optional int32 external_ipv6_prefix_length = 425672143;

Returns
TypeDescription
int

The externalIpv6PrefixLength.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getName()

public String getName()

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getNatIP()

public String getNatIP()

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
TypeDescription
String

The natIP.

getNatIPBytes()

public ByteString getNatIPBytes()

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for networkTier.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for publicPtrDomainName.

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
TypeDescription
boolean

The setPublicPtr.

getType()

public String getType()

The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
ByteString

The bytes for type.

hasExternalIpv6()

public boolean hasExternalIpv6()

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
TypeDescription
boolean

Whether the externalIpv6 field is set.

hasExternalIpv6PrefixLength()

public boolean hasExternalIpv6PrefixLength()

The prefix length of the external IPv6 range.

optional int32 external_ipv6_prefix_length = 425672143;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasNatIP()

public boolean hasNatIP()

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the setPublicPtr field is set.

hasType()

public boolean hasType()

The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.

optional string type = 3575610;

Returns
TypeDescription
boolean

Whether the type field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AccessConfig other)

public AccessConfig.Builder mergeFrom(AccessConfig other)
Parameter
NameDescription
otherAccessConfig
Returns
TypeDescription
AccessConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AccessConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AccessConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AccessConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AccessConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AccessConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AccessConfig.Builder
Overrides

setExternalIpv6(String value)

public AccessConfig.Builder setExternalIpv6(String value)

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;

Parameter
NameDescription
valueString

The externalIpv6 to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setExternalIpv6Bytes(ByteString value)

public AccessConfig.Builder setExternalIpv6Bytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for externalIpv6 to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setExternalIpv6PrefixLength(int value)

public AccessConfig.Builder setExternalIpv6PrefixLength(int value)

The prefix length of the external IPv6 range.

optional int32 external_ipv6_prefix_length = 425672143;

Parameter
NameDescription
valueint

The externalIpv6PrefixLength to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AccessConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AccessConfig.Builder
Overrides

setKind(String value)

public AccessConfig.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setKindBytes(ByteString value)

public AccessConfig.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setName(String value)

public AccessConfig.Builder setName(String value)

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

optional string name = 3373707;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AccessConfig.Builder setNameBytes(ByteString value)

The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

optional string name = 3373707;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setNatIP(String value)

public AccessConfig.Builder setNatIP(String value)

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;

Parameter
NameDescription
valueString

The natIP to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setNatIPBytes(ByteString value)

public AccessConfig.Builder setNatIPBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for natIP to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setNetworkTier(String value)

public AccessConfig.Builder setNetworkTier(String value)

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;

Parameter
NameDescription
valueString

The networkTier to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setNetworkTierBytes(ByteString value)

public AccessConfig.Builder setNetworkTierBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for networkTier to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setPublicPtrDomainName(String value)

public AccessConfig.Builder setPublicPtrDomainName(String value)

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;

Parameter
NameDescription
valueString

The publicPtrDomainName to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setPublicPtrDomainNameBytes(ByteString value)

public AccessConfig.Builder setPublicPtrDomainNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for publicPtrDomainName to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AccessConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AccessConfig.Builder
Overrides

setSetPublicPtr(boolean value)

public AccessConfig.Builder setSetPublicPtr(boolean value)

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;

Parameter
NameDescription
valueboolean

The setPublicPtr to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setType(String value)

public AccessConfig.Builder setType(String value)

The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.

optional string type = 3575610;

Parameter
NameDescription
valueString

The type to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public AccessConfig.Builder setTypeBytes(ByteString value)

The type of configuration. The default and only option is ONE_TO_ONE_NAT. Check the Type enum for the list of possible values.

optional string type = 3575610;

Parameter
NameDescription
valueByteString

The bytes for type to set.

Returns
TypeDescription
AccessConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AccessConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AccessConfig.Builder
Overrides