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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 |
|
SECURITY_POLICY_FIELD_NUMBER
public static final int SECURITY_POLICY_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AccessConfig.Builder newBuilder()
newBuilder(AccessConfig prototype)
public static AccessConfig.Builder newBuilder(AccessConfig prototype)
public static AccessConfig parseDelimitedFrom(InputStream input)
public static AccessConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AccessConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AccessConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AccessConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AccessConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AccessConfig parseFrom(CodedInputStream input)
public static AccessConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AccessConfig parseFrom(InputStream input)
public static AccessConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AccessConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AccessConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AccessConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public AccessConfig getDefaultInstanceForType()
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()
[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()
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()
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()
Overrides
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 created 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 created for first IP in associated external IPv6 range.
optional string public_ptr_domain_name = 316599167;
| Returns |
| Type |
Description |
ByteString |
The bytes for publicPtrDomainName.
|
getSecurityPolicy()
public String getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this access config.
optional string security_policy = 171082513;
| Returns |
| Type |
Description |
String |
The securityPolicy.
|
getSecurityPolicyBytes()
public ByteString getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this access config.
optional string security_policy = 171082513;
| Returns |
| Type |
Description |
ByteString |
The bytes for securityPolicy.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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()
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()
[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()
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 created 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.
|
hasSecurityPolicy()
public boolean hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this access config.
optional string security_policy = 171082513;
| Returns |
| Type |
Description |
boolean |
Whether the securityPolicy 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()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AccessConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AccessConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AccessConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
