Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::VpnGateway (v1.4.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::VpnGateway.

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 .

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
Returns
  • (::String) — [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::String) — 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 an VpnGateway.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::String) — 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 an VpnGateway.
Returns
  • (::String) — 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 an VpnGateway.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String
Returns
  • (::String) — 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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.

#network

def network() -> ::String
Returns
  • (::String) — URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

#network=

def network=(value) -> ::String
Parameter
  • value (::String) — URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
Returns
  • (::String) — URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.

#region

def region() -> ::String
Returns
  • (::String) — [Output Only] URL of the region where the VPN gateway resides.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — [Output Only] URL of the region where the VPN gateway resides.
Returns
  • (::String) — [Output Only] URL of the region where the VPN gateway resides.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#stack_type

def stack_type() -> ::String
Returns
  • (::String) — The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used. Check the StackType enum for the list of possible values.

#stack_type=

def stack_type=(value) -> ::String
Parameter
  • value (::String) — The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used. Check the StackType enum for the list of possible values.
Returns
  • (::String) — The stack type for this VPN gateway to identify the IP protocols that are enabled. If not specified, IPV4_ONLY will be used. Check the StackType enum for the list of possible values.

#vpn_interfaces

def vpn_interfaces() -> ::Array<::Google::Cloud::Compute::V1::VpnGatewayVpnGatewayInterface>
Returns

#vpn_interfaces=

def vpn_interfaces=(value) -> ::Array<::Google::Cloud::Compute::V1::VpnGatewayVpnGatewayInterface>
Parameter
Returns