class Google::Cloud::Compute::V1::Subnetworks::Rest::ServiceStub
REST service stub for the Subnetworks
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/subnetworks/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 aggregated_list
REST call
@param request_pb [::Google::Cloud::Compute::V1::AggregatedListSubnetworksRequest]
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::SubnetworkAggregatedList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SubnetworkAggregatedList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/subnetworks/rest/service_stub.rb, line 55 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::SubnetworkAggregatedList.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::DeleteSubnetworkRequest]
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/subnetworks/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
Baseline implementation for the expand_ip_cidr_range
REST call
@param request_pb [::Google::Cloud::Compute::V1::ExpandIpCidrRangeSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 129 def expand_ip_cidr_range request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_expand_ip_cidr_range_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::GetSubnetworkRequest]
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::Subnetwork] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::Subnetwork]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/subnetworks/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::Subnetwork.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::GetIamPolicySubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 203 def get_iam_policy request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_get_iam_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::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::InsertSubnetworkRequest]
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/subnetworks/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::ListSubnetworksRequest]
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::SubnetworkList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::SubnetworkList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/subnetworks/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::SubnetworkList.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the list_usable
REST call
@param request_pb [::Google::Cloud::Compute::V1::ListUsableSubnetworksRequest]
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::UsableSubnetworksAggregatedList] @yieldparam response [::Faraday::Response]
@return [::Google::Cloud::Compute::V1::UsableSubnetworksAggregatedList]
A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/subnetworks/rest/service_stub.rb, line 314 def list_usable request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_list_usable_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::UsableSubnetworksAggregatedList.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::PatchSubnetworkRequest]
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/subnetworks/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 set_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetIamPolicySubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 388 def set_iam_policy request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_set_iam_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::Policy.decode_json response.body, ignore_unknown_fields: true yield result, response if block_given? result end
Baseline implementation for the set_private_ip_google_access
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetPrivateIpGoogleAccessSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 425 def set_private_ip_google_access request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_set_private_ip_google_access_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 test_iam_permissions
REST call
@param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 462 def test_iam_permissions request_pb, options = nil raise ::ArgumentError, "request must be provided" if request_pb.nil? verb, uri, query_string_params, body = transcode_test_iam_permissions_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::TestPermissionsResponse.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 aggregated_list
REST call
@param request_pb [::Google::Cloud::Compute::V1::AggregatedListSubnetworksRequest]
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/subnetworks/rest/service_stub.rb, line 497 def transcode_aggregated_list_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/aggregated/subnetworks", 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::DeleteSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 518 def transcode_delete_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :delete, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["subnetwork", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the expand_ip_cidr_range
REST call
@param request_pb [::Google::Cloud::Compute::V1::ExpandIpCidrRangeSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 541 def transcode_expand_ip_cidr_range_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange", body: "subnetworks_expand_ip_cidr_range_request_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["subnetwork", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the get_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::GetIamPolicySubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 588 def transcode_get_iam_policy_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["resource", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the get REST call
@param request_pb [::Google::Cloud::Compute::V1::GetSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 565 def transcode_get_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["subnetwork", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the insert REST call
@param request_pb [::Google::Cloud::Compute::V1::InsertSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 611 def transcode_insert_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks", body: "subnetwork_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the list REST call
@param request_pb [::Google::Cloud::Compute::V1::ListSubnetworksRequest]
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/subnetworks/rest/service_stub.rb, line 634 def transcode_list_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the list_usable
REST call
@param request_pb [::Google::Cloud::Compute::V1::ListUsableSubnetworksRequest]
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/subnetworks/rest/service_stub.rb, line 656 def transcode_list_usable_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :get, uri_template: "/compute/v1/projects/{project}/aggregated/subnetworks/listUsable", 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::PatchSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 677 def transcode_patch_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :patch, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}", body: "subnetwork_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["subnetwork", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the set_iam_policy
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetIamPolicySubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 701 def transcode_set_iam_policy_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy", body: "region_set_policy_request_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["resource", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the set_private_ip_google_access
REST call
@param request_pb [::Google::Cloud::Compute::V1::SetPrivateIpGoogleAccessSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 725 def transcode_set_private_ip_google_access_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess", body: "subnetworks_set_private_ip_google_access_request_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["subnetwork", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end
@private
GRPC transcoding helper method for the test_iam_permissions
REST call
@param request_pb [::Google::Cloud::Compute::V1::TestIamPermissionsSubnetworkRequest]
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/subnetworks/rest/service_stub.rb, line 749 def transcode_test_iam_permissions_request request_pb transcoder = Gapic::Rest::GrpcTranscoder.new .with_bindings( uri_method: :post, uri_template: "/compute/v1/projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions", body: "test_permissions_request_resource", matches: [ ["project", %r{^[^/]+/?$}, false], ["region", %r{^[^/]+/?$}, false], ["resource", %r{^[^/]+/?$}, false] ] ) transcoder.transcode request_pb end