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

REST service stub for the BackendBuckets 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/backend_buckets/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

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

Baseline implementation for the add_signed_url_key REST call

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

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

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

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/backend_buckets/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
delete_signed_url_key(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the delete_signed_url_key REST call

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

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

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

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

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

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

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/backend_buckets/rest/service_stub.rb, line 203
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
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::ListBackendBucketsRequest]

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

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

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

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/backend_buckets/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
set_edge_security_policy(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the set_edge_security_policy REST call

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

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

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

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/backend_buckets/rest/service_stub.rb, line 351
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

transcode_add_signed_url_key_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the add_signed_url_key REST call

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

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/backend_buckets/rest/service_stub.rb, line 386
def transcode_add_signed_url_key_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets/{backend_bucket}/addSignedUrlKey",
                                            body: "signed_url_key_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["backend_bucket", %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::DeleteBackendBucketRequest]

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

@private

GRPC transcoding helper method for the delete_signed_url_key REST call

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

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/backend_buckets/rest/service_stub.rb, line 431
def transcode_delete_signed_url_key_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets/{backend_bucket}/deleteSignedUrlKey",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["backend_bucket", %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::GetBackendBucketRequest]

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/backend_buckets/rest/service_stub.rb, line 453
def transcode_get_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets/{backend_bucket}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["backend_bucket", %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::InsertBackendBucketRequest]

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/backend_buckets/rest/service_stub.rb, line 475
def transcode_insert_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets",
                                            body: "backend_bucket_resource",
                                            matches: [
                                              ["project", %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::ListBackendBucketsRequest]

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/backend_buckets/rest/service_stub.rb, line 497
def transcode_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets",
                                            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::PatchBackendBucketRequest]

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

@private

GRPC transcoding helper method for the set_edge_security_policy REST call

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

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/backend_buckets/rest/service_stub.rb, line 541
def transcode_set_edge_security_policy_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets/{backend_bucket}/setEdgeSecurityPolicy",
                                            body: "security_policy_reference_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["backend_bucket", %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::UpdateBackendBucketRequest]

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/backend_buckets/rest/service_stub.rb, line 564
def transcode_update_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :put,
                                            uri_template: "/compute/v1/projects/{project}/global/backendBuckets/{backend_bucket}",
                                            body: "backend_bucket_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["backend_bucket", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end