public final class VpnGateway extends GeneratedMessageV3 implements VpnGatewayOrBuilder
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 .
Protobuf type google.cloud.compute.v1.VpnGateway
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
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GATEWAY_IP_VERSION_FIELD_NUMBER
public static final int GATEWAY_IP_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABEL_FINGERPRINT_FIELD_NUMBER
public static final int LABEL_FINGERPRINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STACK_TYPE_FIELD_NUMBER
public static final int STACK_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VPN_INTERFACES_FIELD_NUMBER
public static final int VPN_INTERFACES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static VpnGateway getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static VpnGateway.Builder newBuilder()
newBuilder(VpnGateway prototype)
public static VpnGateway.Builder newBuilder(VpnGateway prototype)
public static VpnGateway parseDelimitedFrom(InputStream input)
public static VpnGateway parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static VpnGateway parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static VpnGateway parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static VpnGateway parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VpnGateway parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static VpnGateway parseFrom(CodedInputStream input)
public static VpnGateway parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static VpnGateway parseFrom(InputStream input)
public static VpnGateway parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static VpnGateway parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static VpnGateway parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<VpnGateway> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
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.
map<string, string> labels = 500195327;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns |
| Type |
Description |
String |
The creationTimestamp.
|
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns |
| Type |
Description |
ByteString |
The bytes for creationTimestamp.
|
getDefaultInstanceForType()
public VpnGateway getDefaultInstanceForType()
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getGatewayIpVersion()
public String getGatewayIpVersion()
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.
Check the GatewayIpVersion enum for the list of possible values.
optional string gateway_ip_version = 65074843;
| Returns |
| Type |
Description |
String |
The gatewayIpVersion.
|
getGatewayIpVersionBytes()
public ByteString getGatewayIpVersionBytes()
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.
Check the GatewayIpVersion enum for the list of possible values.
optional string gateway_ip_version = 65074843;
| Returns |
| Type |
Description |
ByteString |
The bytes for gatewayIpVersion.
|
getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns |
| Type |
Description |
long |
The id.
|
getKind()
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
optional string kind = 3292052;
| Returns |
| Type |
Description |
String |
The kind.
|
getKindBytes()
public ByteString getKindBytes()
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
optional string kind = 3292052;
| Returns |
| Type |
Description |
ByteString |
The bytes for kind.
|
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.
optional string label_fingerprint = 178124825;
| Returns |
| Type |
Description |
String |
The labelFingerprint.
|
getLabelFingerprintBytes()
public ByteString getLabelFingerprintBytes()
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.
optional string label_fingerprint = 178124825;
| Returns |
| Type |
Description |
ByteString |
The bytes for labelFingerprint.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
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.
map<string, string> labels = 500195327;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
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.
map<string, string> labels = 500195327;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> labels = 500195327;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
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.
map<string, string> labels = 500195327;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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? 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.
optional string name = 3373707;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
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? 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.
optional string name = 3373707;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
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.
optional string network = 232872494;
| Returns |
| Type |
Description |
String |
The network.
|
getNetworkBytes()
public ByteString getNetworkBytes()
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
optional string network = 232872494;
| Returns |
| Type |
Description |
ByteString |
The bytes for network.
|
getParserForType()
public Parser<VpnGateway> getParserForType()
Overrides
getRegion()
public String getRegion()
[Output Only] URL of the region where the VPN gateway resides.
optional string region = 138946292;
| Returns |
| Type |
Description |
String |
The region.
|
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] URL of the region where the VPN gateway resides.
optional string region = 138946292;
| Returns |
| Type |
Description |
ByteString |
The bytes for region.
|
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns |
| Type |
Description |
String |
The selfLink.
|
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns |
| Type |
Description |
ByteString |
The bytes for selfLink.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
Check the StackType enum for the list of possible values.
optional string stack_type = 425908881;
| Returns |
| Type |
Description |
String |
The stackType.
|
getStackTypeBytes()
public ByteString getStackTypeBytes()
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.
Check the StackType enum for the list of possible values.
optional string stack_type = 425908881;
| Returns |
| Type |
Description |
ByteString |
The bytes for stackType.
|
getVpnInterfaces(int index)
public VpnGatewayVpnGatewayInterface getVpnInterfaces(int index)
The list of VPN interfaces associated with this VPN gateway.
repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
| Parameter |
| Name |
Description |
index |
int
|
getVpnInterfacesCount()
public int getVpnInterfacesCount()
The list of VPN interfaces associated with this VPN gateway.
repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
| Returns |
| Type |
Description |
int |
|
getVpnInterfacesList()
public List<VpnGatewayVpnGatewayInterface> getVpnInterfacesList()
The list of VPN interfaces associated with this VPN gateway.
repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
getVpnInterfacesOrBuilder(int index)
public VpnGatewayVpnGatewayInterfaceOrBuilder getVpnInterfacesOrBuilder(int index)
The list of VPN interfaces associated with this VPN gateway.
repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
| Parameter |
| Name |
Description |
index |
int
|
getVpnInterfacesOrBuilderList()
public List<? extends VpnGatewayVpnGatewayInterfaceOrBuilder> getVpnInterfacesOrBuilderList()
The list of VPN interfaces associated with this VPN gateway.
repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.compute.v1.VpnGatewayVpnGatewayInterfaceOrBuilder> |
|
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns |
| Type |
Description |
boolean |
Whether the creationTimestamp field is set.
|
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
| Type |
Description |
boolean |
Whether the description field is set.
|
hasGatewayIpVersion()
public boolean hasGatewayIpVersion()
The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not specified, IPV4 will be used.
Check the GatewayIpVersion enum for the list of possible values.
optional string gateway_ip_version = 65074843;
| Returns |
| Type |
Description |
boolean |
Whether the gatewayIpVersion field is set.
|
hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns |
| Type |
Description |
boolean |
Whether the id field is set.
|
hasKind()
[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
optional string kind = 3292052;
| Returns |
| Type |
Description |
boolean |
Whether the kind field is set.
|
hasLabelFingerprint()
public boolean hasLabelFingerprint()
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.
optional string label_fingerprint = 178124825;
| Returns |
| Type |
Description |
boolean |
Whether the labelFingerprint field is set.
|
hasName()
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? 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.
optional string name = 3373707;
| Returns |
| Type |
Description |
boolean |
Whether the name field is set.
|
hasNetwork()
public boolean hasNetwork()
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
optional string network = 232872494;
| Returns |
| Type |
Description |
boolean |
Whether the network field is set.
|
hasRegion()
public boolean hasRegion()
[Output Only] URL of the region where the VPN gateway resides.
optional string region = 138946292;
| Returns |
| Type |
Description |
boolean |
Whether the region field is set.
|
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns |
| Type |
Description |
boolean |
Whether the selfLink field is set.
|
hasStackType()
public boolean hasStackType()
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.
Check the StackType enum for the list of possible values.
optional string stack_type = 425908881;
| Returns |
| Type |
Description |
boolean |
Whether the stackType field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public VpnGateway.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected VpnGateway.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public VpnGateway.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
