Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::TargetVpnGateway.
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.
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.
#forwarding_rules
def forwarding_rules() -> ::Array<::String>
Returns
- (::Array<::String>) — [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
#forwarding_rules=
def forwarding_rules=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
Returns
- (::Array<::String>) — [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
#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#targetVpnGateway for target VPN gateways.
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
Returns
- (::String) — [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
#label_fingerprint
def label_fingerprint() -> ::String
Returns
- (::String) — 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.
#label_fingerprint=
def label_fingerprint=(value) -> ::String
Parameter
- value (::String) — 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
- (::String) — 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.
#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 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.
#region=
def region=(value) -> ::String
Parameter
- value (::String) — [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
- (::String) — [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.
#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.
#status
def status() -> ::String
Returns
- (::String) — [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. Check the Status enum for the list of possible values.
#status=
def status=(value) -> ::String
Parameter
- value (::String) — [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. Check the Status enum for the list of possible values.
Returns
- (::String) — [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. Check the Status enum for the list of possible values.
#tunnels
def tunnels() -> ::Array<::String>
Returns
- (::Array<::String>) — [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
#tunnels=
def tunnels=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — [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
- (::Array<::String>) — [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.