Reference documentation and code samples for the Google Cloud Compute V1 API 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
Inherits
- Object
Methods
#aggregated_list
def aggregated_list(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::RouterAggregatedList
Baseline implementation for the aggregated_list REST call
- request_pb (::Google::Cloud::Compute::V1::AggregatedListRoutersRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::RouterAggregatedList)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::RouterAggregatedList) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete
def delete(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation
Baseline implementation for the delete REST call
- request_pb (::Google::Cloud::Compute::V1::DeleteRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Operation)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#get
def get(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Router
Baseline implementation for the get REST call
- request_pb (::Google::Cloud::Compute::V1::GetRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Router)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::Router) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_nat_mapping_info
def get_nat_mapping_info(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::VmEndpointNatMappingsList
Baseline implementation for the get_nat_mapping_info REST call
- request_pb (::Google::Cloud::Compute::V1::GetNatMappingInfoRoutersRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::VmEndpointNatMappingsList)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::VmEndpointNatMappingsList) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_router_status
def get_router_status(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::RouterStatusResponse
Baseline implementation for the get_router_status REST call
- request_pb (::Google::Cloud::Compute::V1::GetRouterStatusRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::RouterStatusResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::RouterStatusResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, credentials:) -> ServiceStub
- (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
- request_pb (::Google::Cloud::Compute::V1::InsertRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Operation)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#list
def list(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::RouterList
Baseline implementation for the list REST call
- request_pb (::Google::Cloud::Compute::V1::ListRoutersRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::RouterList)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::RouterList) — A result object deserialized from the server's reply
- (::ArgumentError)
#patch
def patch(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation
Baseline implementation for the patch REST call
- request_pb (::Google::Cloud::Compute::V1::PatchRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Operation)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#preview
def preview(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::RoutersPreviewResponse
Baseline implementation for the preview REST call
- request_pb (::Google::Cloud::Compute::V1::PreviewRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::RoutersPreviewResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::RoutersPreviewResponse) — A result object deserialized from the server's reply
- (::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
- request_pb (::Google::Cloud::Compute::V1::AggregatedListRoutersRequest) — A request object representing the call parameters. Required.
- (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
- request_pb (::Google::Cloud::Compute::V1::DeleteRouterRequest) — A request object representing the call parameters. Required.
- (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters
#transcode_get_nat_mapping_info_request
def transcode_get_nat_mapping_info_request(request_pb) -> Array(String, [String, nil], Hash{String => String})
GRPC transcoding helper method for the get_nat_mapping_info REST call
- request_pb (::Google::Cloud::Compute::V1::GetNatMappingInfoRoutersRequest) — A request object representing the call parameters. Required.
- (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
- request_pb (::Google::Cloud::Compute::V1::GetRouterRequest) — A request object representing the call parameters. Required.
- (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters
#transcode_get_router_status_request
def transcode_get_router_status_request(request_pb) -> Array(String, [String, nil], Hash{String => String})
GRPC transcoding helper method for the get_router_status REST call
- request_pb (::Google::Cloud::Compute::V1::GetRouterStatusRouterRequest) — A request object representing the call parameters. Required.
- (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
- request_pb (::Google::Cloud::Compute::V1::InsertRouterRequest) — A request object representing the call parameters. Required.
- (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
- request_pb (::Google::Cloud::Compute::V1::ListRoutersRequest) — A request object representing the call parameters. Required.
- (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters
#transcode_patch_request
def transcode_patch_request(request_pb) -> Array(String, [String, nil], Hash{String => String})
GRPC transcoding helper method for the patch REST call
- request_pb (::Google::Cloud::Compute::V1::PatchRouterRequest) — A request object representing the call parameters. Required.
- (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters
#transcode_preview_request
def transcode_preview_request(request_pb) -> Array(String, [String, nil], Hash{String => String})
GRPC transcoding helper method for the preview REST call
- request_pb (::Google::Cloud::Compute::V1::PreviewRouterRequest) — A request object representing the call parameters. Required.
- (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters
#transcode_update_request
def transcode_update_request(request_pb) -> Array(String, [String, nil], Hash{String => String})
GRPC transcoding helper method for the update REST call
- request_pb (::Google::Cloud::Compute::V1::UpdateRouterRequest) — A request object representing the call parameters. Required.
- (Array(String, [String, nil], Hash{String => String})) — Uri, Body, Query string parameters
#update
def update(request_pb, options = nil) { |result, response| ... } -> ::Google::Cloud::Compute::V1::Operation
Baseline implementation for the update REST call
- request_pb (::Google::Cloud::Compute::V1::UpdateRouterRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Operation)
- response (::Faraday::Response)
- (::Google::Cloud::Compute::V1::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)