com.google.api.services.compute.model

Class VpnGateway

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.VpnGateway

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Represents a HA VPN gateway. HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies .

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
VpnGateway()

Method Summary

Modifier and Type	Method and Description
VpnGateway	clone()
byte[]	decodeLabelFingerprint() A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking.
VpnGateway	encodeLabelFingerprint(byte[] labelFingerprint) A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
String	getGatewayIpVersion() The IP family of the gateway IPs for the HA-VPN gateway interfaces.
BigInteger	getId() [Output Only] The unique identifier for the resource.
String	getKind() [Output Only] Type of resource.
String	getLabelFingerprint() A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking.
Map<String,String>	getLabels() Labels for this resource.
String	getName() Name of the resource.
String	getNetwork() URL of the network to which this VPN gateway is attached.
String	getRegion() [Output Only] URL of the region where the VPN gateway resides.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
String	getStackType() The stack type for this VPN gateway to identify the IP protocols that are enabled.
List<VpnGatewayVpnGatewayInterface>	getVpnInterfaces() The list of VPN interfaces associated with this VPN gateway.
VpnGateway	set(String fieldName, Object value)
VpnGateway	setCreationTimestamp(String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
VpnGateway	setDescription(String description) An optional description of this resource.
VpnGateway	setGatewayIpVersion(String gatewayIpVersion) The IP family of the gateway IPs for the HA-VPN gateway interfaces.
VpnGateway	setId(BigInteger id) [Output Only] The unique identifier for the resource.
VpnGateway	setKind(String kind) [Output Only] Type of resource.
VpnGateway	setLabelFingerprint(String labelFingerprint) A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking.
VpnGateway	setLabels(Map<String,String> labels) Labels for this resource.
VpnGateway	setName(String name) Name of the resource.
VpnGateway	setNetwork(String network) URL of the network to which this VPN gateway is attached.
VpnGateway	setRegion(String region) [Output Only] URL of the region where the VPN gateway resides.
VpnGateway	setSelfLink(String selfLink) [Output Only] Server-defined URL for the resource.
VpnGateway	setStackType(String stackType) The stack type for this VPN gateway to identify the IP protocols that are enabled.
VpnGateway	setVpnInterfaces(List<VpnGatewayVpnGatewayInterface> vpnInterfaces) The list of VPN interfaces associated with this VPN gateway.

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

VpnGateway

public VpnGateway()

Method Detail

getCreationTimestamp

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public VpnGateway setCreationTimestamp(String creationTimestamp)

[Output Only] Creation timestamp in RFC3339 text format.

Parameters:

creationTimestamp - creationTimestamp or null for none

getDescription

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

Returns:

value or null for none

setDescription

public VpnGateway setDescription(String description)

An optional description of this resource. Provide this property when you create the resource.

Parameters:

description - description or null for none

getGatewayIpVersion

public String getGatewayIpVersion()

The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.

Returns:

value or null for none

setGatewayIpVersion

public VpnGateway setGatewayIpVersion(String gatewayIpVersion)

The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.

Parameters:

gatewayIpVersion - gatewayIpVersion or null for none

getId

public BigInteger getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

value or null for none

setId

public VpnGateway setId(BigInteger id)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:

id - id or null for none

getKind

public String getKind()

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

Returns:

value or null for none

setKind

public VpnGateway setKind(String kind)

[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

Parameters:

kind - kind or null for none

getLabelFingerprint

public String getLabelFingerprint()

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.

Returns:

value or null for none

See Also:

decodeLabelFingerprint()

decodeLabelFingerprint

public byte[] decodeLabelFingerprint()

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getLabelFingerprint()

setLabelFingerprint

public VpnGateway setLabelFingerprint(String labelFingerprint)

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.

Parameters:

labelFingerprint - labelFingerprint or null for none

See Also:

#encodeLabelFingerprint()

encodeLabelFingerprint

public VpnGateway encodeLabelFingerprint(byte[] labelFingerprint)

A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getLabels

public Map<String,String> getLabels()

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Returns:

value or null for none

setLabels

public VpnGateway setLabels(Map<String,String> labels)

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.

Parameters:

labels - labels or null for none

getName

public String getName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns:

value or null for none

setName

public VpnGateway setName(String name)

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameters:

name - name or null for none

getNetwork

public String getNetwork()

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

Returns:

value or null for none

setNetwork

public VpnGateway setNetwork(String network)

URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

Parameters:

network - network or null for none

getRegion

public String getRegion()

[Output Only] URL of the region where the VPN gateway resides.

Returns:

value or null for none

setRegion

public VpnGateway setRegion(String region)

[Output Only] URL of the region where the VPN gateway resides.

Parameters:

region - region or null for none

getSelfLink

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

Returns:

value or null for none

setSelfLink

public VpnGateway setSelfLink(String selfLink)

[Output Only] Server-defined URL for the resource.

Parameters:

selfLink - selfLink or null for none

getStackType

public String getStackType()

The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.

Returns:

value or null for none

setStackType

public VpnGateway setStackType(String stackType)

The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.

Parameters:

stackType - stackType or null for none

getVpnInterfaces

public List<VpnGatewayVpnGatewayInterface> getVpnInterfaces()

The list of VPN interfaces associated with this VPN gateway.

Returns:

value or null for none

setVpnInterfaces

public VpnGateway setVpnInterfaces(List<VpnGatewayVpnGatewayInterface> vpnInterfaces)

The list of VPN interfaces associated with this VPN gateway.

Parameters:

vpnInterfaces - vpnInterfaces or null for none

set

public VpnGateway set(String fieldName,
                      Object value)

Overrides:

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

clone

public VpnGateway clone()

Overrides:

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