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

REST service stub for the Routers 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/routers/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

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

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

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

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

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

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/routers/rest/service_stub.rb, line 105
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::GetRouterRequest]

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/routers/rest/service_stub.rb, line 150
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::Router.decode_json response.body, ignore_unknown_fields: true

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

Baseline implementation for the get_nat_mapping_info REST call

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

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

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

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

  uri, _body, query_string_params = transcode_get_nat_mapping_info_request request_pb
  response = @client_stub.make_get_request(
    uri:     uri,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::VmEndpointNatMappingsList.decode_json response.body, ignore_unknown_fields: true

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

Baseline implementation for the get_router_status REST call

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

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

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

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

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

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/routers/rest/service_stub.rb, line 285
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::ListRoutersRequest]

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/routers/rest/service_stub.rb, line 331
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::RouterList.decode_json response.body, ignore_unknown_fields: true

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

Baseline implementation for the patch REST call

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

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

  uri, body, query_string_params = transcode_patch_request request_pb
  response = @client_stub.make_patch_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
preview(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the preview REST call

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

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

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

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

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

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

GRPC transcoding helper method for the aggregated_list REST call

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

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/routers/rest/service_stub.rb, line 77
def transcode_aggregated_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/aggregated/routers"
  body = nil
  query_string_params = {}
  query_string_params["filter"] = request_pb.filter.to_s if request_pb.has_filter?
  query_string_params["includeAllScopes"] = request_pb.include_all_scopes.to_s if request_pb.has_include_all_scopes?
  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_delete_request(request_pb) click to toggle source

GRPC transcoding helper method for the delete REST call

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

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/routers/rest/service_stub.rb, line 127
def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}"
  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_nat_mapping_info_request(request_pb) click to toggle source

GRPC transcoding helper method for the get_nat_mapping_info REST call

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

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/routers/rest/service_stub.rb, line 215
def transcode_get_nat_mapping_info_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}/getNatMappingInfo"
  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_get_request(request_pb) click to toggle source

GRPC transcoding helper method for the get REST call

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

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/routers/rest/service_stub.rb, line 171
def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}"
  body = nil
  query_string_params = {}

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

GRPC transcoding helper method for the get_router_status REST call

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

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/routers/rest/service_stub.rb, line 263
def transcode_get_router_status_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}/getRouterStatus"
  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::InsertRouterRequest]

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/routers/rest/service_stub.rb, line 308
def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers"
  body = request_pb.router_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::ListRoutersRequest]

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/routers/rest/service_stub.rb, line 353
def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers"
  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_patch_request(request_pb) click to toggle source

GRPC transcoding helper method for the patch REST call

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

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/routers/rest/service_stub.rb, line 403
def transcode_patch_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}"
  body = request_pb.router_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_preview_request(request_pb) click to toggle source

GRPC transcoding helper method for the preview REST call

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

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/routers/rest/service_stub.rb, line 448
def transcode_preview_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}/preview"
  body = request_pb.router_resource.to_json
  query_string_params = {}

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

GRPC transcoding helper method for the update REST call

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

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/routers/rest/service_stub.rb, line 493
def transcode_update_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/routers/#{request_pb.router}"
  body = request_pb.router_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
update(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the update REST call

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

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

  uri, body, query_string_params = transcode_update_request request_pb
  response = @client_stub.make_put_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