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

REST service stub for the Networks 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/networks/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

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

Baseline implementation for the add_peering REST call

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

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

  uri, body, query_string_params = transcode_add_peering_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
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::DeleteNetworkRequest]

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/networks/rest/service_stub.rb, line 101
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::GetNetworkRequest]

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

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

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

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

Baseline implementation for the get_effective_firewalls REST call

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

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

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

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

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

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/networks/rest/service_stub.rb, line 232
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::ListNetworksRequest]

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

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

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

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

Baseline implementation for the list_peering_routes REST call

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

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

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

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

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

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/networks/rest/service_stub.rb, line 379
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
remove_peering(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the remove_peering REST call

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

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

  uri, body, query_string_params = transcode_remove_peering_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
switch_to_custom_mode(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the switch_to_custom_mode REST call

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

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

  uri, _body, query_string_params = transcode_switch_to_custom_mode_request request_pb
  response = @client_stub.make_post_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
transcode_add_peering_request(request_pb) click to toggle source

GRPC transcoding helper method for the add_peering REST call

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

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/networks/rest/service_stub.rb, line 78
def transcode_add_peering_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/addPeering"
  body = request_pb.networks_add_peering_request_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_delete_request(request_pb) click to toggle source

GRPC transcoding helper method for the delete REST call

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

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/networks/rest/service_stub.rb, line 123
def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}"
  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_effective_firewalls_request(request_pb) click to toggle source

GRPC transcoding helper method for the get_effective_firewalls REST call

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

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/networks/rest/service_stub.rb, line 210
def transcode_get_effective_firewalls_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/getEffectiveFirewalls"
  body = nil
  query_string_params = {}

  [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::GetNetworkRequest]

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/networks/rest/service_stub.rb, line 167
def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}"
  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::InsertNetworkRequest]

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/networks/rest/service_stub.rb, line 255
def transcode_insert_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks"
  body = request_pb.network_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_peering_routes_request(request_pb) click to toggle source

GRPC transcoding helper method for the list_peering_routes REST call

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

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/networks/rest/service_stub.rb, line 349
def transcode_list_peering_routes_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/listPeeringRoutes"
  body = nil
  query_string_params = {}
  query_string_params["direction"] = request_pb.direction.to_s if request_pb.has_direction?
  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["peeringName"] = request_pb.peering_name.to_s if request_pb.has_peering_name?
  query_string_params["region"] = request_pb.region.to_s if request_pb.has_region?
  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_list_request(request_pb) click to toggle source

GRPC transcoding helper method for the list REST call

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

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/networks/rest/service_stub.rb, line 300
def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks"
  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::PatchNetworkRequest]

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/networks/rest/service_stub.rb, line 402
def transcode_patch_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}"
  body = request_pb.network_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_remove_peering_request(request_pb) click to toggle source

GRPC transcoding helper method for the remove_peering REST call

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

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/networks/rest/service_stub.rb, line 448
def transcode_remove_peering_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/removePeering"
  body = request_pb.networks_remove_peering_request_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_switch_to_custom_mode_request(request_pb) click to toggle source

GRPC transcoding helper method for the switch_to_custom_mode REST call

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

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/networks/rest/service_stub.rb, line 493
def transcode_switch_to_custom_mode_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/switchToCustomMode"
  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_update_peering_request(request_pb) click to toggle source

GRPC transcoding helper method for the update_peering REST call

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

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/networks/rest/service_stub.rb, line 539
def transcode_update_peering_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/networks/#{request_pb.network}/updatePeering"
  body = request_pb.networks_update_peering_request_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_peering(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the update_peering REST call

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

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

  uri, body, query_string_params = transcode_update_peering_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