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
# 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, numeric_enums: false end
Public Instance Methods
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? 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::RouterAggregatedList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
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 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
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 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::Router.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
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 166 def get_nat_mapping_info request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_get_nat_mapping_info_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::VmEndpointNatMappingsList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
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 203 def get_router_status request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_get_router_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::RouterStatusResponse.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
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 240 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
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 277 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::RouterList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
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 314 def patch request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_patch_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
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 351 def preview request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_preview_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::RoutersPreviewResponse.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
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 388 def update request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_update_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
Private Instance Methods
@private
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 423 def transcode_aggregated_list_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/aggregated/routers", matches: [ ["project", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 444 def transcode_delete_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :delete, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 490 def transcode_get_nat_mapping_info_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 467 def transcode_get_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 513 def transcode_get_router_status_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/getRouterStatus", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 536 def transcode_insert_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers", body: "router_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 559 def transcode_list_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 581 def transcode_patch_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :patch, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}", body: "router_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 605 def transcode_preview_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}/preview", body: "router_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
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 629 def transcode_update_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :put, uri_template: "/compute/v1/projects/{project}/regions/{region}/routers/{router}", body: "router_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["router", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end