class Google::Cloud::Compute::V1::ExternalVpnGateways::Rest::ServiceStub

REST service stub for the ExternalVpnGateways 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/external_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
end

Public Instance Methods

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::DeleteExternalVpnGatewayRequest]

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/external_vpn_gateways/rest/service_stub.rb, line 55
def delete request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  uri, _body, query_string_params = transcode_delete_request request_pb
  response = @client_stub.make_delete_request(
    uri:     uri,
    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::GetExternalVpnGatewayRequest]

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::ExternalVpnGateway] @yieldparam response [::Faraday::Response]

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

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

  uri, _body, _query_string_params = transcode_get_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::ExternalVpnGateway.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::InsertExternalVpnGatewayRequest]

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/external_vpn_gateways/rest/service_stub.rb, line 143
def insert request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  uri, body, query_string_params = transcode_insert_request request_pb
  response = @client_stub.make_post_request(
    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::ListExternalVpnGatewaysRequest]

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::ExternalVpnGatewayList] @yieldparam response [::Faraday::Response]

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

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

  uri, _body, query_string_params = transcode_list_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::ExternalVpnGatewayList.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::SetLabelsExternalVpnGatewayRequest]

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/external_vpn_gateways/rest/service_stub.rb, line 238
def set_labels request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  uri, body, _query_string_params = transcode_set_labels_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    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::TestIamPermissionsExternalVpnGatewayRequest]

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/external_vpn_gateways/rest/service_stub.rb, line 282
def test_iam_permissions request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  uri, body, _query_string_params = transcode_test_iam_permissions_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::TestPermissionsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end
transcode_delete_request(request_pb) click to toggle source

GRPC transcoding helper method for the delete REST call

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

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/external_vpn_gateways/rest/service_stub.rb, line 77
def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/externalVpnGateways/#{request_pb.external_vpn_gateway}"
  body = nil
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end
transcode_get_request(request_pb) click to toggle source

GRPC transcoding helper method for the get REST call

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

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/external_vpn_gateways/rest/service_stub.rb, line 121
def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/externalVpnGateways/#{request_pb.external_vpn_gateway}"
  body = nil
  query_string_params = {}

  [uri, body, query_string_params]
end
transcode_insert_request(request_pb) click to toggle source

GRPC transcoding helper method for the insert REST call

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

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/external_vpn_gateways/rest/service_stub.rb, line 166
def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/externalVpnGateways"
  body = request_pb.external_vpn_gateway_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end
transcode_list_request(request_pb) click to toggle source

GRPC transcoding helper method for the list REST call

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

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/external_vpn_gateways/rest/service_stub.rb, line 211
def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/externalVpnGateways"
  body = nil
  query_string_params = {}
  query_string_params["filter"] = request_pb.filter.to_s if request_pb.has_filter?
  query_string_params["maxResults"] = request_pb.max_results.to_s if request_pb.has_max_results?
  query_string_params["orderBy"] = request_pb.order_by.to_s if request_pb.has_order_by?
  query_string_params["pageToken"] = request_pb.page_token.to_s if request_pb.has_page_token?
  query_string_params["returnPartialSuccess"] = request_pb.return_partial_success.to_s if request_pb.has_return_partial_success?

  [uri, body, query_string_params]
end
transcode_set_labels_request(request_pb) click to toggle source

GRPC transcoding helper method for the set_labels REST call

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

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/external_vpn_gateways/rest/service_stub.rb, line 260
def transcode_set_labels_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/externalVpnGateways/#{request_pb.resource}/setLabels"
  body = request_pb.global_set_labels_request_resource.to_json
  query_string_params = {}

  [uri, body, query_string_params]
end
transcode_test_iam_permissions_request(request_pb) click to toggle source

GRPC transcoding helper method for the test_iam_permissions REST call

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

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/external_vpn_gateways/rest/service_stub.rb, line 304
def transcode_test_iam_permissions_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/externalVpnGateways/#{request_pb.resource}/testIamPermissions"
  body = request_pb.test_permissions_request_resource.to_json
  query_string_params = {}

  [uri, body, query_string_params]
end