class Google::Cloud::Compute::V1::TargetPools::Rest::ServiceStub
REST service stub for the TargetPools
service. service stub contains baseline method implementations including transcoding, making the REST call and deserialing the response
Public Class Methods
# File lib/google/cloud/compute/v1/target_pools/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
Baseline implementation for the add_health_check
REST call
@param request_pb [::Google::Cloud::Compute::V1::AddHealthCheckTargetPoolRequest]
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_pools/rest/service_stub.rb, line 55 def add_health_check request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, query_string_params = transcode_add_health_check_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
Baseline implementation for the add_instance
REST call
@param request_pb [::Google::Cloud::Compute::V1::AddInstanceTargetPoolRequest]
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_pools/rest/service_stub.rb, line 101 def add_instance request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, query_string_params = transcode_add_instance_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
Baseline implementation for the aggregated_list
REST call
@param request_pb [::Google::Cloud::Compute::V1::AggregatedListTargetPoolsRequest]
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::TargetPoolAggregatedList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::TargetPoolAggregatedList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/target_pools/rest/service_stub.rb, line 147 def aggregated_list request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, _body, query_string_params = transcode_aggregated_list_request request_pb response = @client_stub.make_get_request( uri: uri, params: query_string_params, options: options ) result = ::Google::Cloud::Compute::V1::TargetPoolAggregatedList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the delete REST call
@param request_pb [::Google::Cloud::Compute::V1::DeleteTargetPoolRequest]
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_pools/rest/service_stub.rb, line 197 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
Baseline implementation for the get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetTargetPoolRequest]
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::TargetPool] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::TargetPool]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/target_pools/rest/service_stub.rb, line 242 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::TargetPool.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the get_health
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetHealthTargetPoolRequest]
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::TargetPoolInstanceHealth] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::TargetPoolInstanceHealth]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/target_pools/rest/service_stub.rb, line 285 def get_health request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, _query_string_params = transcode_get_health_request request_pb response = @client_stub.make_post_request( uri: uri, body: body, options: options ) result = ::Google::Cloud::Compute::V1::TargetPoolInstanceHealth.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the insert REST call
@param request_pb [::Google::Cloud::Compute::V1::InsertTargetPoolRequest]
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_pools/rest/service_stub.rb, line 329 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
Baseline implementation for the list REST call
@param request_pb [::Google::Cloud::Compute::V1::ListTargetPoolsRequest]
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::TargetPoolList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::TargetPoolList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/target_pools/rest/service_stub.rb, line 375 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::TargetPoolList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the remove_health_check
REST call
@param request_pb [::Google::Cloud::Compute::V1::RemoveHealthCheckTargetPoolRequest]
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_pools/rest/service_stub.rb, line 424 def remove_health_check request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, query_string_params = transcode_remove_health_check_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
Baseline implementation for the remove_instance
REST call
@param request_pb [::Google::Cloud::Compute::V1::RemoveInstanceTargetPoolRequest]
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_pools/rest/service_stub.rb, line 470 def remove_instance request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, query_string_params = transcode_remove_instance_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
Baseline implementation for the set_backup
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetBackupTargetPoolRequest]
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_pools/rest/service_stub.rb, line 516 def set_backup request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, query_string_params = transcode_set_backup_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
GRPC transcoding helper method for the add_health_check
REST call
@param request_pb [::Google::Cloud::Compute::V1::AddHealthCheckTargetPoolRequest]
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_pools/rest/service_stub.rb, line 78 def transcode_add_health_check_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}/addHealthCheck" body = request_pb.target_pools_add_health_check_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
GRPC transcoding helper method for the add_instance
REST call
@param request_pb [::Google::Cloud::Compute::V1::AddInstanceTargetPoolRequest]
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_pools/rest/service_stub.rb, line 124 def transcode_add_instance_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}/addInstance" body = request_pb.target_pools_add_instance_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
GRPC transcoding helper method for the aggregated_list
REST call
@param request_pb [::Google::Cloud::Compute::V1::AggregatedListTargetPoolsRequest]
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_pools/rest/service_stub.rb, line 169 def transcode_aggregated_list_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/aggregated/targetPools" body = nil query_string_params = {} query_string_params["filter"] = request_pb.filter.to_s if request_pb.has_filter? query_string_params["includeAllScopes"] = request_pb.include_all_scopes.to_s if request_pb.has_include_all_scopes? 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
GRPC transcoding helper method for the delete REST call
@param request_pb [::Google::Cloud::Compute::V1::DeleteTargetPoolRequest]
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_pools/rest/service_stub.rb, line 219 def transcode_delete_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}" 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
GRPC transcoding helper method for the get_health
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetHealthTargetPoolRequest]
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_pools/rest/service_stub.rb, line 307 def transcode_get_health_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}/getHealth" body = request_pb.instance_reference_resource.to_json query_string_params = {} [uri, body, query_string_params] end
GRPC transcoding helper method for the get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetTargetPoolRequest]
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_pools/rest/service_stub.rb, line 263 def transcode_get_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}" body = nil query_string_params = {} [uri, body, query_string_params] end
GRPC transcoding helper method for the insert REST call
@param request_pb [::Google::Cloud::Compute::V1::InsertTargetPoolRequest]
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_pools/rest/service_stub.rb, line 352 def transcode_insert_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools" body = request_pb.target_pool_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
GRPC transcoding helper method for the list REST call
@param request_pb [::Google::Cloud::Compute::V1::ListTargetPoolsRequest]
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_pools/rest/service_stub.rb, line 397 def transcode_list_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools" 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
GRPC transcoding helper method for the remove_health_check
REST call
@param request_pb [::Google::Cloud::Compute::V1::RemoveHealthCheckTargetPoolRequest]
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_pools/rest/service_stub.rb, line 447 def transcode_remove_health_check_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}/removeHealthCheck" body = request_pb.target_pools_remove_health_check_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
GRPC transcoding helper method for the remove_instance
REST call
@param request_pb [::Google::Cloud::Compute::V1::RemoveInstanceTargetPoolRequest]
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_pools/rest/service_stub.rb, line 493 def transcode_remove_instance_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}/removeInstance" body = request_pb.target_pools_remove_instance_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
GRPC transcoding helper method for the set_backup
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetBackupTargetPoolRequest]
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_pools/rest/service_stub.rb, line 539 def transcode_set_backup_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/targetPools/#{request_pb.target_pool}/setBackup" body = request_pb.target_reference_resource.to_json query_string_params = {} query_string_params["failoverRatio"] = request_pb.failover_ratio.to_s if request_pb.has_failover_ratio? query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id? [uri, body, query_string_params] end