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

REST service stub for the UrlMaps 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/url_maps/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

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

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/url_maps/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::UrlMapsAggregatedList.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::DeleteUrlMapRequest]

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/url_maps/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
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::GetUrlMapRequest]

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/url_maps/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::UrlMap.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::InsertUrlMapRequest]

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

Baseline implementation for the invalidate_cache REST call

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

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

  verb, uri, query_string_params, body = transcode_invalidate_cache_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
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::ListUrlMapsRequest]

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/url_maps/rest/service_stub.rb, line 240
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::UrlMapList.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::PatchUrlMapRequest]

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/url_maps/rest/service_stub.rb, line 277
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
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::UpdateUrlMapRequest]

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

Baseline implementation for the validate REST call

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

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

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

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

  verb, uri, query_string_params, body = transcode_validate_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::UrlMapsValidateResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

Private Instance Methods

transcode_aggregated_list_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the aggregated_list REST call

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

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/url_maps/rest/service_stub.rb, line 386
def transcode_aggregated_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/aggregated/urlMaps",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_delete_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the delete REST call

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

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/url_maps/rest/service_stub.rb, line 407
def transcode_delete_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :delete,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps/{url_map}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["url_map", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_get_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the get REST call

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

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/url_maps/rest/service_stub.rb, line 429
def transcode_get_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps/{url_map}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["url_map", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_insert_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the insert REST call

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

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/url_maps/rest/service_stub.rb, line 451
def transcode_insert_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps",
                                            body: "url_map_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_invalidate_cache_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the invalidate_cache REST call

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

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/url_maps/rest/service_stub.rb, line 473
def transcode_invalidate_cache_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps/{url_map}/invalidateCache",
                                            body: "cache_invalidation_rule_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["url_map", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_list_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the list REST call

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

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/url_maps/rest/service_stub.rb, line 496
def transcode_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_patch_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the patch REST call

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

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/url_maps/rest/service_stub.rb, line 517
def transcode_patch_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :patch,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps/{url_map}",
                                            body: "url_map_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["url_map", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_update_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the update REST call

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

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/url_maps/rest/service_stub.rb, line 540
def transcode_update_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :put,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps/{url_map}",
                                            body: "url_map_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["url_map", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_validate_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the validate REST call

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

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/url_maps/rest/service_stub.rb, line 563
def transcode_validate_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/urlMaps/{url_map}/validate",
                                            body: "url_maps_validate_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["url_map", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end