Class ExternalVpnGateway (1.23.0)

public final class ExternalVpnGateway extends GeneratedMessageV3 implements ExternalVpnGatewayOrBuilder

Represents an external VPN gateway. External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway. For more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN.

Protobuf type google.cloud.compute.v1.ExternalVpnGateway

Static Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INTERFACES_FIELD_NUMBER

public static final int INTERFACES_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REDUNDANCY_TYPE_FIELD_NUMBER

public static final int REDUNDANCY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExternalVpnGateway getDefaultInstance()
Returns
TypeDescription
ExternalVpnGateway

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExternalVpnGateway.Builder newBuilder()
Returns
TypeDescription
ExternalVpnGateway.Builder

newBuilder(ExternalVpnGateway prototype)

public static ExternalVpnGateway.Builder newBuilder(ExternalVpnGateway prototype)
Parameter
NameDescription
prototypeExternalVpnGateway
Returns
TypeDescription
ExternalVpnGateway.Builder

parseDelimitedFrom(InputStream input)

public static ExternalVpnGateway parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExternalVpnGateway parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExternalVpnGateway parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExternalVpnGateway parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExternalVpnGateway parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExternalVpnGateway parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExternalVpnGateway parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExternalVpnGateway parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExternalVpnGateway parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExternalVpnGateway parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExternalVpnGateway parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExternalVpnGateway parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExternalVpnGateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExternalVpnGateway> parser()
Returns
TypeDescription
Parser<ExternalVpnGateway>

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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public ExternalVpnGateway getDefaultInstanceForType()
Returns
TypeDescription
ExternalVpnGateway

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getInterfaces(int index)

public ExternalVpnGatewayInterface getInterfaces(int index)

A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.

repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExternalVpnGatewayInterface

getInterfacesCount()

public int getInterfacesCount()

A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.

repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;

Returns
TypeDescription
int

getInterfacesList()

public List<ExternalVpnGatewayInterface> getInterfacesList()

A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.

repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;

Returns
TypeDescription
List<ExternalVpnGatewayInterface>

getInterfacesOrBuilder(int index)

public ExternalVpnGatewayInterfaceOrBuilder getInterfacesOrBuilder(int index)

A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.

repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExternalVpnGatewayInterfaceOrBuilder

getInterfacesOrBuilderList()

public List<? extends ExternalVpnGatewayInterfaceOrBuilder> getInterfacesOrBuilderList()

A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway.

repeated .google.cloud.compute.v1.ExternalVpnGatewayInterface interfaces = 12073562;

Returns
TypeDescription
List<? extends com.google.cloud.compute.v1.ExternalVpnGatewayInterfaceOrBuilder>

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getLabelFingerprint()

public String getLabelFingerprint()

A fingerprint for the labels being applied to this ExternalVpnGateway, 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 an ExternalVpnGateway.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

A fingerprint for the labels being applied to this ExternalVpnGateway, 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 an ExternalVpnGateway.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
ByteString

The bytes for labelFingerprint.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

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

Returns
TypeDescription
Map<String,String>

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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

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? 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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ExternalVpnGateway> getParserForType()
Returns
TypeDescription
Parser<ExternalVpnGateway>
Overrides

getRedundancyType()

public String getRedundancyType()

Indicates the user-supplied redundancy type of this external VPN gateway. Check the RedundancyType enum for the list of possible values.

optional string redundancy_type = 271443740;

Returns
TypeDescription
String

The redundancyType.

getRedundancyTypeBytes()

public ByteString getRedundancyTypeBytes()

Indicates the user-supplied redundancy type of this external VPN gateway. Check the RedundancyType enum for the list of possible values.

optional string redundancy_type = 271443740;

Returns
TypeDescription
ByteString

The bytes for redundancyType.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the description field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

A fingerprint for the labels being applied to this ExternalVpnGateway, 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 an ExternalVpnGateway.

optional string label_fingerprint = 178124825;

Returns
TypeDescription
boolean

Whether the labelFingerprint field is set.

hasName()

public boolean 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
TypeDescription
boolean

Whether the name field is set.

hasRedundancyType()

public boolean hasRedundancyType()

Indicates the user-supplied redundancy type of this external VPN gateway. Check the RedundancyType enum for the list of possible values.

optional string redundancy_type = 271443740;

Returns
TypeDescription
boolean

Whether the redundancyType field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExternalVpnGateway.Builder newBuilderForType()
Returns
TypeDescription
ExternalVpnGateway.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExternalVpnGateway.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExternalVpnGateway.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExternalVpnGateway.Builder toBuilder()
Returns
TypeDescription
ExternalVpnGateway.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException