com.google.api.services.compute.model

Class AccessConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.AccessConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AccessConfig
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AccessConfig()

Method Summary

Modifier and Type	Method and Description
AccessConfig	clone()
String	getExternalIpv6() Applies to ipv6AccessConfigs only.
Integer	getExternalIpv6PrefixLength() Applies to ipv6AccessConfigs only.
String	getKind() [Output Only] Type of the resource.
String	getName() The name of this access configuration.
String	getNatIP() Applies to accessConfigs (IPv4) only.
String	getNetworkTier() This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
String	getPublicPtrDomainName() The DNS domain name for the public PTR record.
String	getSecurityPolicy() The resource URL for the security policy associated with this access config.
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.
String	getType() The type of configuration.
AccessConfig	set(String fieldName, Object value)
AccessConfig	setExternalIpv6(String externalIpv6) Applies to ipv6AccessConfigs only.
AccessConfig	setExternalIpv6PrefixLength(Integer externalIpv6PrefixLength) Applies to ipv6AccessConfigs only.
AccessConfig	setKind(String kind) [Output Only] Type of the resource.
AccessConfig	setName(String name) The name of this access configuration.
AccessConfig	setNatIP(String natIP) Applies to accessConfigs (IPv4) only.
AccessConfig	setNetworkTier(String networkTier) This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.
AccessConfig	setPublicPtrDomainName(String publicPtrDomainName) The DNS domain name for the public PTR record.
AccessConfig	setSecurityPolicy(String securityPolicy) The resource URL for the security policy associated with this access config.
AccessConfig	setSetPublicPtr(Boolean setPublicPtr) Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
AccessConfig	setType(String type) The type of configuration.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

AccessConfig

public AccessConfig()

Method Detail

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.

Returns:

value or null for none

setExternalIpv6

public AccessConfig setExternalIpv6(String externalIpv6)

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.

Parameters:

externalIpv6 - externalIpv6 or null for none

getExternalIpv6PrefixLength

public Integer getExternalIpv6PrefixLength()

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

Returns:

value or null for none

setExternalIpv6PrefixLength

public AccessConfig setExternalIpv6PrefixLength(Integer externalIpv6PrefixLength)

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

Parameters:

externalIpv6PrefixLength - externalIpv6PrefixLength or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public AccessConfig setKind(String kind)

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

Parameters:

kind - kind or null for none

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.

Returns:

value or null for none

setName

public AccessConfig setName(String name)

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.

Parameters:

name - name or null for none

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.

Returns:

value or null for none

setNatIP

public AccessConfig setNatIP(String natIP)

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.

Parameters:

natIP - natIP or null for none

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.

Returns:

value or null for none

setNetworkTier

public AccessConfig setNetworkTier(String networkTier)

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.

Parameters:

networkTier - networkTier or null for none

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.

Returns:

value or null for none

setPublicPtrDomainName

public AccessConfig setPublicPtrDomainName(String publicPtrDomainName)

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.

Parameters:

publicPtrDomainName - publicPtrDomainName or null for none

getSecurityPolicy

public String getSecurityPolicy()

The resource URL for the security policy associated with this access config.

Returns:

value or null for none

setSecurityPolicy

public AccessConfig setSecurityPolicy(String securityPolicy)

The resource URL for the security policy associated with this access config.

Parameters:

securityPolicy - securityPolicy or null for none

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.

Returns:

value or null for none

setSetPublicPtr

public AccessConfig setSetPublicPtr(Boolean setPublicPtr)

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.

Parameters:

setPublicPtr - setPublicPtr or null for none

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.

Returns:

value or null for none

setType

public AccessConfig setType(String type)

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.

Parameters:

type - type or null for none

set

public AccessConfig set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AccessConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson