class Google::Cloud::Compute::V1::Images::Rest::ServiceStub
REST service stub for the Images
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/images/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 delete REST call
@param request_pb [::Google::Cloud::Compute::V1::DeleteImageRequest]
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/images/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
Baseline implementation for the deprecate REST call
@param request_pb [::Google::Cloud::Compute::V1::DeprecateImageRequest]
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/images/rest/service_stub.rb, line 100 def deprecate request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, query_string_params = transcode_deprecate_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 get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetImageRequest]
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::Image] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Image]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/images/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::Image.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the get_from_family
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetFromFamilyImageRequest]
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::Image] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Image]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/images/rest/service_stub.rb, line 189 def get_from_family request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, _body, _query_string_params = transcode_get_from_family_request request_pb response = @client_stub.make_get_request( uri: uri, options: options ) result = ::Google::Cloud::Compute::V1::Image.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the get_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetIamPolicyImageRequest]
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::Policy] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Policy]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/images/rest/service_stub.rb, line 232 def get_iam_policy request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, _body, query_string_params = transcode_get_iam_policy_request request_pb response = @client_stub.make_get_request( uri: uri, params: query_string_params, options: options ) result = ::Google::Cloud::Compute::V1::Policy.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::InsertImageRequest]
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/images/rest/service_stub.rb, line 277 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::ListImagesRequest]
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::ImageList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::ImageList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/images/rest/service_stub.rb, line 324 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::ImageList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the patch REST call
@param request_pb [::Google::Cloud::Compute::V1::PatchImageRequest]
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/images/rest/service_stub.rb, line 373 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
Baseline implementation for the set_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetIamPolicyImageRequest]
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::Policy] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Policy]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/images/rest/service_stub.rb, line 419 def set_iam_policy request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, _query_string_params = transcode_set_iam_policy_request request_pb response = @client_stub.make_post_request( uri: uri, body: body, options: options ) result = ::Google::Cloud::Compute::V1::Policy.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the set_labels
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetLabelsImageRequest]
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/images/rest/service_stub.rb, line 463 def set_labels request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, _query_string_params = transcode_set_labels_request request_pb response = @client_stub.make_post_request( uri: uri, body: body, 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 test_iam_permissions
REST call
@param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsImageRequest]
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::TestPermissionsResponse] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::TestPermissionsResponse]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/images/rest/service_stub.rb, line 507 def test_iam_permissions request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? uri, body, _query_string_params = transcode_test_iam_permissions_request request_pb response = @client_stub.make_post_request( uri: uri, body: body, options: options ) result = ::Google::Cloud::Compute::V1::TestPermissionsResponse.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
GRPC transcoding helper method for the delete REST call
@param request_pb [::Google::Cloud::Compute::V1::DeleteImageRequest]
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/images/rest/service_stub.rb, line 77 def transcode_delete_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.image}" 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 deprecate REST call
@param request_pb [::Google::Cloud::Compute::V1::DeprecateImageRequest]
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/images/rest/service_stub.rb, line 123 def transcode_deprecate_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.image}/deprecate" body = request_pb.deprecation_status_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 get_from_family
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetFromFamilyImageRequest]
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/images/rest/service_stub.rb, line 210 def transcode_get_from_family_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/family/#{request_pb.family}" body = nil query_string_params = {} [uri, body, query_string_params] end
GRPC transcoding helper method for the get_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetIamPolicyImageRequest]
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/images/rest/service_stub.rb, line 254 def transcode_get_iam_policy_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/getIamPolicy" body = nil query_string_params = {} query_string_params["optionsRequestedPolicyVersion"] = request_pb.options_requested_policy_version.to_s if request_pb.has_options_requested_policy_version? [uri, body, query_string_params] end
GRPC transcoding helper method for the get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetImageRequest]
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/images/rest/service_stub.rb, line 167 def transcode_get_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.image}" 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::InsertImageRequest]
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/images/rest/service_stub.rb, line 300 def transcode_insert_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images" body = request_pb.image_resource.to_json query_string_params = {} query_string_params["forceCreate"] = request_pb.force_create.to_s if request_pb.has_force_create? 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::ListImagesRequest]
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/images/rest/service_stub.rb, line 346 def transcode_list_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images" 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 patch REST call
@param request_pb [::Google::Cloud::Compute::V1::PatchImageRequest]
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/images/rest/service_stub.rb, line 396 def transcode_patch_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.image}" body = request_pb.image_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_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetIamPolicyImageRequest]
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/images/rest/service_stub.rb, line 441 def transcode_set_iam_policy_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/setIamPolicy" body = request_pb.global_set_policy_request_resource.to_json query_string_params = {} [uri, body, query_string_params] end
GRPC transcoding helper method for the set_labels
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetLabelsImageRequest]
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/images/rest/service_stub.rb, line 485 def transcode_set_labels_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/setLabels" body = request_pb.global_set_labels_request_resource.to_json query_string_params = {} [uri, body, query_string_params] end
GRPC transcoding helper method for the test_iam_permissions
REST call
@param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsImageRequest]
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/images/rest/service_stub.rb, line 529 def transcode_test_iam_permissions_request request_pb uri = "/compute/v1/projects/#{request_pb.project}/global/images/#{request_pb.resource}/testIamPermissions" body = request_pb.test_permissions_request_resource.to_json query_string_params = {} [uri, body, query_string_params] end