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.

Public Class Methods

new(endpoint:, credentials: require "gapic/rest") click to toggle source
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 33
def initialize endpoint:, credentials:
  # These require statements are intentionally placed here to initialize
  # the REST modules only when it's required.
  require "gapic/rest"

  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials, numeric_enums: false
end

Public Instance Methods

aggregated_list(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the aggregated_list REST call

@param request_pb [::Google::Cloud::Compute::V1::AggregatedListVpnGatewaysRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::VpnGatewayAggregatedList] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::VpnGatewayAggregatedList]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 55
def aggregated_list request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_aggregated_list_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::VpnGatewayAggregatedList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
delete(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the delete REST call

@param request_pb [::Google::Cloud::Compute::V1::DeleteVpnGatewayRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::Operation] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::Operation]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 92
def delete request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_delete_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
get(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the get REST call

@param request_pb [::Google::Cloud::Compute::V1::GetVpnGatewayRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::VpnGateway] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::VpnGateway]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 129
def get request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_get_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::VpnGateway.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
get_status(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the get_status REST call

@param request_pb [::Google::Cloud::Compute::V1::GetStatusVpnGatewayRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 166
def get_status request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_get_status_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::VpnGatewaysGetStatusResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
insert(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the insert REST call

@param request_pb [::Google::Cloud::Compute::V1::InsertVpnGatewayRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::Operation] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::Operation]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 203
def insert request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_insert_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
list(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the list REST call

@param request_pb [::Google::Cloud::Compute::V1::ListVpnGatewaysRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::VpnGatewayList] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::VpnGatewayList]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 240
def list request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_list_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::VpnGatewayList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
set_labels(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the set_labels REST call

@param request_pb [::Google::Cloud::Compute::V1::SetLabelsVpnGatewayRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::Operation] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::Operation]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 277
def set_labels request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_set_labels_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
test_iam_permissions(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the test_iam_permissions REST call

@param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsVpnGatewayRequest]

A request object representing the call parameters. Required.

@param options [::Gapic::CallOptions]

Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

@yield [result, response] Access the result along with the Faraday response object @yieldparam result [::Google::Cloud::Compute::V1::TestPermissionsResponse] @yieldparam response [::Faraday::Response]

@return [::Google::Cloud::Compute::V1::TestPermissionsResponse]

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 314
def test_iam_permissions request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_test_iam_permissions_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split("=", 2) }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::TestPermissionsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

Private Instance Methods

transcode_aggregated_list_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the aggregated_list REST call

@param request_pb [::Google::Cloud::Compute::V1::AggregatedListVpnGatewaysRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 349
def transcode_aggregated_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/aggregated/vpnGateways",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_delete_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the delete REST call

@param request_pb [::Google::Cloud::Compute::V1::DeleteVpnGatewayRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 370
def transcode_delete_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :delete,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false],
                                              ["vpn_gateway", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_get_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the get REST call

@param request_pb [::Google::Cloud::Compute::V1::GetVpnGatewayRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 393
def transcode_get_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false],
                                              ["vpn_gateway", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_get_status_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the get_status REST call

@param request_pb [::Google::Cloud::Compute::V1::GetStatusVpnGatewayRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 416
def transcode_get_status_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}/getStatus",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false],
                                              ["vpn_gateway", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_insert_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the insert REST call

@param request_pb [::Google::Cloud::Compute::V1::InsertVpnGatewayRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 439
def transcode_insert_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways",
                                            body: "vpn_gateway_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_list_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the list REST call

@param request_pb [::Google::Cloud::Compute::V1::ListVpnGatewaysRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 462
def transcode_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_set_labels_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the set_labels REST call

@param request_pb [::Google::Cloud::Compute::V1::SetLabelsVpnGatewayRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 484
def transcode_set_labels_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels",
                                            body: "region_set_labels_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false],
                                              ["resource", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_test_iam_permissions_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the test_iam_permissions REST call

@param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsVpnGatewayRequest]

A request object representing the call parameters. Required.

@return [Array(String, [String, nil], Hash{String => String})]

Uri, Body, Query string parameters
# File lib/google/cloud/compute/v1/vpn_gateways/rest/service_stub.rb, line 508
def transcode_test_iam_permissions_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions",
                                            body: "test_permissions_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["region", %r{^[^/]+/?$}, false],
                                              ["resource", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end