target.apidocs.com.google.api.services.compute.model.TargetVpnGateway.html Maven / Gradle / Ivy

Go to download







TargetVpnGateway (Compute Engine API beta-rev20220726-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class TargetVpnGateway



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class TargetVpnGateway
extends GenericJson
Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic
 Cloud VPN gateway. For more information, read the the Cloud VPN Overview.

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


TargetVpnGateway() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TargetVpnGateway
clone() 


byte[]
decodeLabelFingerprint()
A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a
 hash of the labels set used for optimistic locking.



TargetVpnGateway
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this TargetVpnGateway, 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.



List<String>
getForwardingRules()
[Output Only] A list of URLs to the ForwardingRule resources.



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 TargetVpnGateway, 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 target VPN gateway resides.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



String
getStatus()
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING,
 READY, FAILED, or DELETING.



List<String>
getTunnels()
[Output Only] A list of URLs to VpnTunnel resources.



TargetVpnGateway
set(String fieldName,
   Object value) 


TargetVpnGateway
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



TargetVpnGateway
setDescription(String description)
An optional description of this resource.



TargetVpnGateway
setForwardingRules(List<String> forwardingRules)
[Output Only] A list of URLs to the ForwardingRule resources.



TargetVpnGateway
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



TargetVpnGateway
setKind(String kind)
[Output Only] Type of resource.



TargetVpnGateway
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a
 hash of the labels set used for optimistic locking.



TargetVpnGateway
setLabels(Map<String,String> labels)
Labels for this resource.



TargetVpnGateway
setName(String name)
Name of the resource.



TargetVpnGateway
setNetwork(String network)
URL of the network to which this VPN gateway is attached.



TargetVpnGateway
setRegion(String region)
[Output Only] URL of the region where the target VPN gateway resides.



TargetVpnGateway
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



TargetVpnGateway
setStatus(String status)
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING,
 READY, FAILED, or DELETING.



TargetVpnGateway
setTunnels(List<String> tunnels)
[Output Only] A list of URLs to VpnTunnel resources.







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





TargetVpnGateway
public TargetVpnGateway()









Method Detail





getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public TargetVpnGateway 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 TargetVpnGateway setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getForwardingRules
public List<String> getForwardingRules()
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using
 compute.forwardingRules.insert and associated with a VPN gateway.

Returns:
value or null for none








setForwardingRules
public TargetVpnGateway setForwardingRules(List<String> forwardingRules)
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using
 compute.forwardingRules.insert and associated with a VPN gateway.

Parameters:
forwardingRules - forwardingRules 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 TargetVpnGateway 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#targetVpnGateway for target VPN gateways.

Returns:
value or null for none








setKind
public TargetVpnGateway setKind(String kind)
[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.

Parameters:
kind - kind or null for none








getLabelFingerprint
public String getLabelFingerprint()
A fingerprint for the labels being applied to this TargetVpnGateway, 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 TargetVpnGateway.

Returns:
value or null for none
See Also:
decodeLabelFingerprint()








decodeLabelFingerprint
public byte[] decodeLabelFingerprint()
A fingerprint for the labels being applied to this TargetVpnGateway, 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 TargetVpnGateway.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getLabelFingerprint()








setLabelFingerprint
public TargetVpnGateway setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this TargetVpnGateway, 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 TargetVpnGateway.

Parameters:
labelFingerprint - labelFingerprint or null for none
See Also:
#encodeLabelFingerprint()








encodeLabelFingerprint
public TargetVpnGateway encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this TargetVpnGateway, 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 TargetVpnGateway.

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 TargetVpnGateway 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 TargetVpnGateway 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 TargetVpnGateway 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 target VPN gateway resides. You must specify this
 field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns:
value or null for none








setRegion
public TargetVpnGateway setRegion(String region)
[Output Only] URL of the region where the target VPN gateway resides. You must specify this
 field as part of the HTTP request URL. It is not settable as a field in the request body.

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 TargetVpnGateway setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getStatus
public String getStatus()
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING,
 READY, FAILED, or DELETING.

Returns:
value or null for none








setStatus
public TargetVpnGateway setStatus(String status)
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING,
 READY, FAILED, or DELETING.

Parameters:
status - status or null for none








getTunnels
public List<String> getTunnels()
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the
 compute.vpntunnels.insert method and associated with a VPN gateway.

Returns:
value or null for none








setTunnels
public TargetVpnGateway setTunnels(List<String> tunnels)
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the
 compute.vpntunnels.insert method and associated with a VPN gateway.

Parameters:
tunnels - tunnels or null for none








set
public TargetVpnGateway set(String fieldName,
                            Object value)

Overrides:
set in class GenericJson








clone
public TargetVpnGateway clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`TargetVpnGateway`	`clone()`
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking.
`TargetVpnGateway`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this TargetVpnGateway, 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.
`List<String>`	`getForwardingRules()` [Output Only] A list of URLs to the ForwardingRule resources.
`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 TargetVpnGateway, 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 target VPN gateway resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getStatus()` [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
`List<String>`	`getTunnels()` [Output Only] A list of URLs to VpnTunnel resources.
`TargetVpnGateway`	`set(String fieldName, Object value)`
`TargetVpnGateway`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`TargetVpnGateway`	`setDescription(String description)` An optional description of this resource.
`TargetVpnGateway`	`setForwardingRules(List<String> forwardingRules)` [Output Only] A list of URLs to the ForwardingRule resources.
`TargetVpnGateway`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`TargetVpnGateway`	`setKind(String kind)` [Output Only] Type of resource.
`TargetVpnGateway`	`setLabelFingerprint(String labelFingerprint)` A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking.
`TargetVpnGateway`	`setLabels(Map<String,String> labels)` Labels for this resource.
`TargetVpnGateway`	`setName(String name)` Name of the resource.
`TargetVpnGateway`	`setNetwork(String network)` URL of the network to which this VPN gateway is attached.
`TargetVpnGateway`	`setRegion(String region)` [Output Only] URL of the region where the target VPN gateway resides.
`TargetVpnGateway`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`TargetVpnGateway`	`setStatus(String status)` [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
`TargetVpnGateway`	`setTunnels(List<String> tunnels)` [Output Only] A list of URLs to VpnTunnel resources.