Class VpnGateway.Builder (1.65.0)

public static final class VpnGateway.Builder extends GeneratedMessageV3.Builder<VpnGateway.Builder> 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

Implements

VpnGatewayOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllVpnInterfaces(Iterable<? extends VpnGatewayVpnGatewayInterface> values)

public VpnGateway.Builder addAllVpnInterfaces(Iterable<? extends VpnGatewayVpnGatewayInterface> values)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.VpnGatewayVpnGatewayInterface>
Returns
Type Description
VpnGateway.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public VpnGateway.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VpnGateway.Builder
Overrides

addVpnInterfaces(VpnGatewayVpnGatewayInterface value)

public VpnGateway.Builder addVpnInterfaces(VpnGatewayVpnGatewayInterface value)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameter
Name Description
value VpnGatewayVpnGatewayInterface
Returns
Type Description
VpnGateway.Builder

addVpnInterfaces(VpnGatewayVpnGatewayInterface.Builder builderForValue)

public VpnGateway.Builder addVpnInterfaces(VpnGatewayVpnGatewayInterface.Builder builderForValue)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameter
Name Description
builderForValue VpnGatewayVpnGatewayInterface.Builder
Returns
Type Description
VpnGateway.Builder

addVpnInterfaces(int index, VpnGatewayVpnGatewayInterface value)

public VpnGateway.Builder addVpnInterfaces(int index, VpnGatewayVpnGatewayInterface value)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameters
Name Description
index int
value VpnGatewayVpnGatewayInterface
Returns
Type Description
VpnGateway.Builder

addVpnInterfaces(int index, VpnGatewayVpnGatewayInterface.Builder builderForValue)

public VpnGateway.Builder addVpnInterfaces(int index, VpnGatewayVpnGatewayInterface.Builder builderForValue)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameters
Name Description
index int
builderForValue VpnGatewayVpnGatewayInterface.Builder
Returns
Type Description
VpnGateway.Builder

addVpnInterfacesBuilder()

public VpnGatewayVpnGatewayInterface.Builder addVpnInterfacesBuilder()

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Returns
Type Description
VpnGatewayVpnGatewayInterface.Builder

addVpnInterfacesBuilder(int index)

public VpnGatewayVpnGatewayInterface.Builder addVpnInterfacesBuilder(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
Returns
Type Description
VpnGatewayVpnGatewayInterface.Builder

build()

public VpnGateway build()
Returns
Type Description
VpnGateway

buildPartial()

public VpnGateway buildPartial()
Returns
Type Description
VpnGateway

clear()

public VpnGateway.Builder clear()
Returns
Type Description
VpnGateway.Builder
Overrides

clearCreationTimestamp()

public VpnGateway.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

clearDescription()

public VpnGateway.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VpnGateway.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
VpnGateway.Builder
Overrides

clearGatewayIpVersion()

public VpnGateway.Builder clearGatewayIpVersion()

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

This builder for chaining.

clearId()

public VpnGateway.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

clearKind()

public VpnGateway.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

clearLabelFingerprint()

public VpnGateway.Builder clearLabelFingerprint()

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

This builder for chaining.

clearLabels()

public VpnGateway.Builder clearLabels()
Returns
Type Description
VpnGateway.Builder

clearName()

public VpnGateway.Builder clearName()

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

This builder for chaining.

clearNetwork()

public VpnGateway.Builder clearNetwork()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VpnGateway.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
VpnGateway.Builder
Overrides

clearRegion()

public VpnGateway.Builder clearRegion()

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

optional string region = 138946292;

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

public VpnGateway.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

clearStackType()

public VpnGateway.Builder clearStackType()

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

This builder for chaining.

clearVpnInterfaces()

public VpnGateway.Builder clearVpnInterfaces()

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Returns
Type Description
VpnGateway.Builder

clone()

public VpnGateway.Builder clone()
Returns
Type Description
VpnGateway.Builder
Overrides

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
Returns
Type Description
boolean

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()
Returns
Type Description
VpnGateway

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

public long 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()

public String 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()

Use #getLabelsMap() instead.

Returns
Type Description
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
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;

Returns
Type Description
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
Name Description
key String
defaultValue String
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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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
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.

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.

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.

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
Returns
Type Description
VpnGatewayVpnGatewayInterface

getVpnInterfacesBuilder(int index)

public VpnGatewayVpnGatewayInterface.Builder getVpnInterfacesBuilder(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
Returns
Type Description
VpnGatewayVpnGatewayInterface.Builder

getVpnInterfacesBuilderList()

public List<VpnGatewayVpnGatewayInterface.Builder> getVpnInterfacesBuilderList()

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Returns
Type Description
List<Builder>

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;

Returns
Type Description
List<VpnGatewayVpnGatewayInterface>

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
Returns
Type Description
VpnGatewayVpnGatewayInterfaceOrBuilder

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

public boolean 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()

public boolean 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()

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(VpnGateway other)

public VpnGateway.Builder mergeFrom(VpnGateway other)
Parameter
Name Description
other VpnGateway
Returns
Type Description
VpnGateway.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VpnGateway.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
VpnGateway.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public VpnGateway.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
VpnGateway.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VpnGateway.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VpnGateway.Builder
Overrides

putAllLabels(Map<String,String> values)

public VpnGateway.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
VpnGateway.Builder

putLabels(String key, String value)

public VpnGateway.Builder putLabels(String key, String value)

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
Name Description
key String
value String
Returns
Type Description
VpnGateway.Builder

removeLabels(String key)

public VpnGateway.Builder removeLabels(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
VpnGateway.Builder

removeVpnInterfaces(int index)

public VpnGateway.Builder removeVpnInterfaces(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
Returns
Type Description
VpnGateway.Builder

setCreationTimestamp(String value)

public VpnGateway.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public VpnGateway.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setDescription(String value)

public VpnGateway.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public VpnGateway.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VpnGateway.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
VpnGateway.Builder
Overrides

setGatewayIpVersion(String value)

public VpnGateway.Builder setGatewayIpVersion(String value)

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;

Parameter
Name Description
value String

The gatewayIpVersion to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setGatewayIpVersionBytes(ByteString value)

public VpnGateway.Builder setGatewayIpVersionBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for gatewayIpVersion to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setId(long value)

public VpnGateway.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setKind(String value)

public VpnGateway.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setKindBytes(ByteString value)

public VpnGateway.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setLabelFingerprint(String value)

public VpnGateway.Builder setLabelFingerprint(String value)

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;

Parameter
Name Description
value String

The labelFingerprint to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public VpnGateway.Builder setLabelFingerprintBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for labelFingerprint to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setName(String value)

public VpnGateway.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setNameBytes(ByteString value)

public VpnGateway.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setNetwork(String value)

public VpnGateway.Builder setNetwork(String value)

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;

Parameter
Name Description
value String

The network to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public VpnGateway.Builder setNetworkBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for network to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setRegion(String value)

public VpnGateway.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public VpnGateway.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public VpnGateway.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
VpnGateway.Builder
Overrides
public VpnGateway.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public VpnGateway.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setStackType(String value)

public VpnGateway.Builder setStackType(String value)

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;

Parameter
Name Description
value String

The stackType to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setStackTypeBytes(ByteString value)

public VpnGateway.Builder setStackTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for stackType to set.

Returns
Type Description
VpnGateway.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VpnGateway.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
VpnGateway.Builder
Overrides

setVpnInterfaces(int index, VpnGatewayVpnGatewayInterface value)

public VpnGateway.Builder setVpnInterfaces(int index, VpnGatewayVpnGatewayInterface value)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameters
Name Description
index int
value VpnGatewayVpnGatewayInterface
Returns
Type Description
VpnGateway.Builder

setVpnInterfaces(int index, VpnGatewayVpnGatewayInterface.Builder builderForValue)

public VpnGateway.Builder setVpnInterfaces(int index, VpnGatewayVpnGatewayInterface.Builder builderForValue)

The list of VPN interfaces associated with this VPN gateway.

repeated .google.cloud.compute.v1.VpnGatewayVpnGatewayInterface vpn_interfaces = 91842181;

Parameters
Name Description
index int
builderForValue VpnGatewayVpnGatewayInterface.Builder
Returns
Type Description
VpnGateway.Builder