Class: Google::Cloud::Compute::V1::RegionInstanceGroups::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



33
34
35
36
37
38
39
# File 'lib/google/cloud/compute/v1/region_instance_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
end

Instance Method Details

#get(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::InstanceGroup

Baseline implementation for the get REST call

Parameters:

Yields:

  • (result, response)

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 55

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::InstanceGroup.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#list(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::RegionInstanceGroupList

Baseline implementation for the list REST call

Parameters:

Yields:

  • (result, response)

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 98

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::RegionInstanceGroupList.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#list_instances(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::RegionInstanceGroupsListInstances

Baseline implementation for the list_instances REST call

Parameters:

Yields:

  • (result, response)

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 147

def list_instances request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  uri, body, query_string_params = transcode_list_instances_request request_pb
  response = @client_stub.make_post_request(
    uri:     uri,
    body:    body,
    params:  query_string_params,
    options: options
  )
  result = ::Google::Cloud::Compute::V1::RegionInstanceGroupsListInstances.decode_json response.body, ignore_unknown_fields: true

  yield result, response if block_given?
  result
end

#set_named_ports(request_pb, options = nil) {|result, response| ... } ⇒ ::Google::Cloud::Compute::V1::Operation

Baseline implementation for the set_named_ports REST call

Parameters:

Yields:

  • (result, response)

    Access the result along with the Faraday response object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 197

def set_named_ports request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  uri, body, query_string_params = transcode_set_named_ports_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

#transcode_get_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the get REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String}))

    Uri, Body, Query string parameters



76
77
78
79
80
81
82
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 76

def transcode_get_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/instanceGroups/#{request_pb.instance_group}"
  body = nil
  query_string_params = {}

  [uri, body, query_string_params]
end

#transcode_list_instances_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the list_instances REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String}))

    Uri, Body, Query string parameters



170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 170

def transcode_list_instances_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/instanceGroups/#{request_pb.instance_group}/listInstances"
  body = request_pb.region_instance_groups_list_instances_request_resource.to_json
  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

#transcode_list_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the list REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String}))

    Uri, Body, Query string parameters



120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 120

def transcode_list_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/instanceGroups"
  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

#transcode_set_named_ports_request(request_pb) ⇒ Array(String, [String, nil], Hash{String => String})

GRPC transcoding helper method for the set_named_ports REST call

Parameters:

Returns:

  • (Array(String, [String, nil], Hash{String => String}))

    Uri, Body, Query string parameters



220
221
222
223
224
225
226
227
# File 'lib/google/cloud/compute/v1/region_instance_groups/rest/service_stub.rb', line 220

def transcode_set_named_ports_request request_pb
  uri = "/compute/v1/projects/#{request_pb.project}/regions/#{request_pb.region}/instanceGroups/#{request_pb.instance_group}/setNamedPorts"
  body = request_pb.region_instance_groups_set_named_ports_request_resource.to_json
  query_string_params = {}
  query_string_params["requestId"] = request_pb.request_id.to_s if request_pb.has_request_id?

  [uri, body, query_string_params]
end