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

REST service stub for the TargetSslProxies 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/target_ssl_proxies/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

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

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/target_ssl_proxies/rest/service_stub.rb, line 55
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::GetTargetSslProxyRequest]

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

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

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

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/target_ssl_proxies/rest/service_stub.rb, line 143
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::ListTargetSslProxiesRequest]

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

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

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

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

Baseline implementation for the set_backend_service REST call

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

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

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

Baseline implementation for the set_proxy_header REST call

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

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

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

Baseline implementation for the set_ssl_certificates REST call

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

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

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

Baseline implementation for the set_ssl_policy REST call

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

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

  uri, body, query_string_params = transcode_set_ssl_policy_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
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::DeleteTargetSslProxyRequest]

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/target_ssl_proxies/rest/service_stub.rb, line 77
def transcode_delete_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies/#{request_pb.target_ssl_proxy}"
  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_request(request_pb) click to toggle source

GRPC transcoding helper method for the get REST call

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

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/target_ssl_proxies/rest/service_stub.rb, line 121
def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies/#{request_pb.target_ssl_proxy}"
  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::InsertTargetSslProxyRequest]

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

GRPC transcoding helper method for the list REST call

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

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/target_ssl_proxies/rest/service_stub.rb, line 211
def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies"
  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_set_backend_service_request(request_pb) click to toggle source

GRPC transcoding helper method for the set_backend_service REST call

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

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/target_ssl_proxies/rest/service_stub.rb, line 261
def transcode_set_backend_service_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies/#{request_pb.target_ssl_proxy}/setBackendService"
  body = request_pb.target_ssl_proxies_set_backend_service_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_set_proxy_header_request(request_pb) click to toggle source

GRPC transcoding helper method for the set_proxy_header REST call

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

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/target_ssl_proxies/rest/service_stub.rb, line 307
def transcode_set_proxy_header_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies/#{request_pb.target_ssl_proxy}/setProxyHeader"
  body = request_pb.target_ssl_proxies_set_proxy_header_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_set_ssl_certificates_request(request_pb) click to toggle source

GRPC transcoding helper method for the set_ssl_certificates REST call

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

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/target_ssl_proxies/rest/service_stub.rb, line 353
def transcode_set_ssl_certificates_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies/#{request_pb.target_ssl_proxy}/setSslCertificates"
  body = request_pb.target_ssl_proxies_set_ssl_certificates_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_set_ssl_policy_request(request_pb) click to toggle source

GRPC transcoding helper method for the set_ssl_policy REST call

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

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/target_ssl_proxies/rest/service_stub.rb, line 399
def transcode_set_ssl_policy_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/global/targetSslProxies/#{request_pb.target_ssl_proxy}/setSslPolicy"
  body = request_pb.ssl_policy_reference_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