Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::VpnGateways::Rest::ServiceStub (v1.4.0)

Version 1.4.0

• 2.15.0 (latest)
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::VpnGateways::Rest::ServiceStub.

REST service stub for the VpnGateways service. service stub contains baseline method implementations including transcoding, making the REST call and deserialing the response

Inherits

• Object

Methods

#aggregated_list

def aggregated_list(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::VpnGatewayAggregatedList

Baseline implementation for the aggregated_list REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::AggregatedListVpnGatewaysRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::VpnGatewayAggregatedList)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::VpnGatewayAggregatedList) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete

def delete(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the delete REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::DeleteVpnGatewayRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get

def get(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::VpnGateway

Baseline implementation for the get REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::GetVpnGatewayRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::VpnGateway)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::VpnGateway) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_status

def get_status(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse

Baseline implementation for the get_status REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::GetStatusVpnGatewayRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#insert

def insert(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the insert REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::InsertVpnGatewayRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list

def list(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::VpnGatewayList

Baseline implementation for the list REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::ListVpnGatewaysRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::VpnGatewayList)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::VpnGatewayList) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#set_labels

def set_labels(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the set_labels REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::SetLabelsVpnGatewayRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::Operation)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#test_iam_permissions

def test_iam_permissions(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::TestPermissionsResponse

Baseline implementation for the test_iam_permissions REST call

Parameters

• request_pb (::Google::Cloud::Compute::V1::TestIamPermissionsVpnGatewayRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, response) — Access the result along with the Faraday response object

Yield Parameters

• result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
• response (::Faraday::Response)

Returns

• (::Google::Cloud::Compute::V1::TestPermissionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#transcode_aggregated_list_request

def transcode_aggregated_list_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the aggregated_list REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::AggregatedListVpnGatewaysRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_delete_request

def transcode_delete_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the delete REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::DeleteVpnGatewayRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_get_request

def transcode_get_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::GetVpnGatewayRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_get_status_request

def transcode_get_status_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get_status REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::GetStatusVpnGatewayRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_insert_request

def transcode_insert_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the insert REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::InsertVpnGatewayRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_list_request

def transcode_list_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the list REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::ListVpnGatewaysRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_set_labels_request

def transcode_set_labels_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the set_labels REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::SetLabelsVpnGatewayRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters

#transcode_test_iam_permissions_request

def transcode_test_iam_permissions_request(request_pb) -> Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the test_iam_permissions REST call

Parameter

• request_pb (::Google::Cloud::Compute::V1::TestIamPermissionsVpnGatewayRequest) — A request object representing the call parameters. Required.

Returns

• (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters