class Google::Cloud::Compute::V1::SecurityPolicies::Rest::ServiceStub
REST service stub for the SecurityPolicies
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/security_policies/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
Baseline implementation for the add_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::AddRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 55 def add_rule request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_add_rule_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
Baseline implementation for the aggregated_list
REST call
@param request_pb [::Google::Cloud::Compute::V1::AggregatedListSecurityPoliciesRequest]
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::SecurityPoliciesAggregatedList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SecurityPoliciesAggregatedList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb, line 92 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::SecurityPoliciesAggregatedList.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::DeleteSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 129 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
Baseline implementation for the get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetSecurityPolicyRequest]
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::SecurityPolicy] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SecurityPolicy]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/security_policies/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::SecurityPolicy.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the get_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetRuleSecurityPolicyRequest]
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::SecurityPolicyRule] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SecurityPolicyRule]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb, line 203 def get_rule request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_get_rule_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::SecurityPolicyRule.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::InsertSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 240 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
Baseline implementation for the list REST call
@param request_pb [::Google::Cloud::Compute::V1::ListSecurityPoliciesRequest]
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::SecurityPolicyList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SecurityPolicyList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb, line 277 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::SecurityPolicyList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the list_preconfigured_expression_sets
REST call
@param request_pb [::Google::Cloud::Compute::V1::ListPreconfiguredExpressionSetsSecurityPoliciesRequest]
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::SecurityPoliciesListPreconfiguredExpressionSetsResponse] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SecurityPoliciesListPreconfiguredExpressionSetsResponse]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/security_policies/rest/service_stub.rb, line 314 def list_preconfigured_expression_sets request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_list_preconfigured_expression_sets_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::SecurityPoliciesListPreconfiguredExpressionSetsResponse.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::PatchSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 351 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
Baseline implementation for the patch_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::PatchRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 388 def patch_rule request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_patch_rule_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
Baseline implementation for the remove_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::RemoveRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 425 def remove_rule request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_remove_rule_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
Baseline implementation for the set_labels
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetLabelsSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 462 def set_labels request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_set_labels_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
@private
GRPC transcoding helper method for the add_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::AddRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 497 def transcode_add_rule_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}/addRule", body: "security_policy_rule_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the aggregated_list
REST call
@param request_pb [::Google::Cloud::Compute::V1::AggregatedListSecurityPoliciesRequest]
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/security_policies/rest/service_stub.rb, line 520 def transcode_aggregated_list_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/aggregated/securityPolicies", matches: [ ["project", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the delete REST call
@param request_pb [::Google::Cloud::Compute::V1::DeleteSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 541 def transcode_delete_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :delete, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 563 def transcode_get_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the get_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 585 def transcode_get_rule_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}/getRule", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the insert REST call
@param request_pb [::Google::Cloud::Compute::V1::InsertSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 607 def transcode_insert_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/global/securityPolicies", body: "security_policy_resource", matches: [ ["project", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the list_preconfigured_expression_sets
REST call
@param request_pb [::Google::Cloud::Compute::V1::ListPreconfiguredExpressionSetsSecurityPoliciesRequest]
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/security_policies/rest/service_stub.rb, line 650 def transcode_list_preconfigured_expression_sets_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets", matches: [ ["project", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the list REST call
@param request_pb [::Google::Cloud::Compute::V1::ListSecurityPoliciesRequest]
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/security_policies/rest/service_stub.rb, line 629 def transcode_list_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/global/securityPolicies", matches: [ ["project", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the patch REST call
@param request_pb [::Google::Cloud::Compute::V1::PatchSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 671 def transcode_patch_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :patch, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}", body: "security_policy_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the patch_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::PatchRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 694 def transcode_patch_rule_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}/patchRule", body: "security_policy_rule_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the remove_rule
REST call
@param request_pb [::Google::Cloud::Compute::V1::RemoveRuleSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 717 def transcode_remove_rule_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{security_policy}/removeRule", matches: [ ["project", %r{^[^/]+/?$}, false], ["security_policy", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the set_labels
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetLabelsSecurityPolicyRequest]
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/security_policies/rest/service_stub.rb, line 739 def transcode_set_labels_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/global/securityPolicies/{resource}/setLabels", body: "global_set_labels_request_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["resource", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end