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

REST service stub for the NetworkEndpointGroups service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Public Class Methods

new(endpoint:, credentials: require "gapic/rest") click to toggle source
# File lib/google/cloud/compute/v1/network_endpoint_groups/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

aggregated_list(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the aggregated_list REST call

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

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/network_endpoint_groups/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::NetworkEndpointGroupAggregatedList.decode_json response.body, ignore_unknown_fields: true

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

Baseline implementation for the attach_network_endpoints REST call

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

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

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

Baseline implementation for the delete REST call

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

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/network_endpoint_groups/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
detach_network_endpoints(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the detach_network_endpoints REST call

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

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

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

Baseline implementation for the get REST call

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

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

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

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

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

Baseline implementation for the insert REST call

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

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/network_endpoint_groups/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
list(request_pb, options = nil) { |result, response| ... } click to toggle source

Baseline implementation for the list REST call

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

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/network_endpoint_groups/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::NetworkEndpointGroupList.decode_json response.body, ignore_unknown_fields: true

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

Baseline implementation for the list_network_endpoints REST call

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

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

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

A result object deserialized from the server's reply
# File lib/google/cloud/compute/v1/network_endpoint_groups/rest/service_stub.rb, line 314
def list_network_endpoints request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = transcode_list_network_endpoints_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::NetworkEndpointGroupsListNetworkEndpoints.decode_json response.body, ignore_unknown_fields: true

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

Baseline implementation for the test_iam_permissions REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 351
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

transcode_aggregated_list_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the aggregated_list REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 386
def transcode_aggregated_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/aggregated/networkEndpointGroups",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_attach_network_endpoints_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the attach_network_endpoints REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 407
def transcode_attach_network_endpoints_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{network_endpoint_group}/attachNetworkEndpoints",
                                            body: "network_endpoint_groups_attach_endpoints_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false],
                                              ["network_endpoint_group", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_delete_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the delete REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 431
def transcode_delete_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :delete,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{network_endpoint_group}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false],
                                              ["network_endpoint_group", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_detach_network_endpoints_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the detach_network_endpoints REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 454
def transcode_detach_network_endpoints_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{network_endpoint_group}/detachNetworkEndpoints",
                                            body: "network_endpoint_groups_detach_endpoints_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false],
                                              ["network_endpoint_group", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_get_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the get REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 478
def transcode_get_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{network_endpoint_group}",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false],
                                              ["network_endpoint_group", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_insert_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the insert REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 501
def transcode_insert_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups",
                                            body: "network_endpoint_group_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_list_network_endpoints_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the list_network_endpoints REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 546
def transcode_list_network_endpoints_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{network_endpoint_group}/listNetworkEndpoints",
                                            body: "network_endpoint_groups_list_endpoints_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false],
                                              ["network_endpoint_group", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_list_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the list REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 524
def transcode_list_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :get,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end
transcode_test_iam_permissions_request(request_pb) click to toggle source

@private

GRPC transcoding helper method for the test_iam_permissions REST call

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

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/network_endpoint_groups/rest/service_stub.rb, line 570
def transcode_test_iam_permissions_request request_pb
  transcoder = Gapic::Rest::GrpcTranscoder.new
                                          .with_bindings(
                                            uri_method: :post,
                                            uri_template: "/compute/v1/projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions",
                                            body: "test_permissions_request_resource",
                                            matches: [
                                              ["project", %r{^[^/]+/?$}, false],
                                              ["zone", %r{^[^/]+/?$}, false],
                                              ["resource", %r{^[^/]+/?$}, false]
                                            ]
                                          )
  transcoder.transcode request_pb
end