Class: Google::Cloud::AIPlatform::V1::PredictionService::Rest::ServiceStub

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

Overview

REST service stub for the PredictionService 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:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 33

def initialize endpoint:, endpoint_template:, universe_domain:, 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,
                                               endpoint_template: endpoint_template,
                                               universe_domain: universe_domain,
                                               credentials: credentials,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#direct_predict(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::DirectPredictResponse

Baseline implementation for the direct_predict REST call

Parameters:

  • request_pb (::Google::Cloud::AIPlatform::V1::DirectPredictRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 187

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

  verb, uri, query_string_params, body = ServiceStub.transcode_direct_predict_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
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::AIPlatform::V1::DirectPredictResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#direct_raw_predict(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::DirectRawPredictResponse

Baseline implementation for the direct_raw_predict REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 225

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

  verb, uri, query_string_params, body = ServiceStub.transcode_direct_raw_predict_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
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::AIPlatform::V1::DirectRawPredictResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


60
61
62
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 60

def endpoint
  @client_stub.endpoint
end

#explain(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::ExplainResponse

Baseline implementation for the explain REST call

Parameters:

  • request_pb (::Google::Cloud::AIPlatform::V1::ExplainRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 296

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

  verb, uri, query_string_params, body = ServiceStub.transcode_explain_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
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::AIPlatform::V1::ExplainResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#generate_content(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::GenerateContentResponse

Baseline implementation for the generate_content REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 334

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

  verb, uri, query_string_params, body = ServiceStub.transcode_generate_content_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
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::AIPlatform::V1::GenerateContentResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#predict(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AIPlatform::V1::PredictResponse

Baseline implementation for the predict REST call

Parameters:

  • request_pb (::Google::Cloud::AIPlatform::V1::PredictRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 78

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

  verb, uri, query_string_params, body = ServiceStub.transcode_predict_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
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::AIPlatform::V1::PredictResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#raw_predict(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Api::HttpBody

Baseline implementation for the raw_predict REST call

Parameters:

  • request_pb (::Google::Cloud::AIPlatform::V1::RawPredictRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 116

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

  verb, uri, query_string_params, body = ServiceStub.transcode_raw_predict_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
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Api::HttpBody.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#server_streaming_predict(request_pb, options = nil) {|chunk| ... } ⇒ ::Gapic::Rest::TransportOperation

Baseline implementation for the server_streaming_predict REST call

Parameters:

Yield Parameters:

  • chunk (::String) —

    The chunk of data received during server streaming.

Returns:

  • (::Gapic::Rest::TransportOperation)

Raises:

  • (::ArgumentError) 


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 260

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

  verb, uri, query_string_params, body = ServiceStub.transcode_server_streaming_predict_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,
    is_server_streaming: true,
    &block
  )
  ::Gapic::Rest::TransportOperation.new response
end

#stream_generate_content(request_pb, options = nil) {|chunk| ... } ⇒ ::Gapic::Rest::TransportOperation

Baseline implementation for the stream_generate_content REST call

Parameters:

Yield Parameters:

  • chunk (::String) —

    The chunk of data received during server streaming.

Returns:

  • (::Gapic::Rest::TransportOperation)

Raises:

  • (::ArgumentError) 


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 369

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

  verb, uri, query_string_params, body = ServiceStub.transcode_stream_generate_content_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,
    is_server_streaming: true,
    &block
  )
  ::Gapic::Rest::TransportOperation.new response
end

#stream_raw_predict(request_pb, options = nil) {|chunk| ... } ⇒ ::Gapic::Rest::TransportOperation

Baseline implementation for the stream_raw_predict REST call

Parameters:

Yield Parameters:

  • chunk (::String) —

    The chunk of data received during server streaming.

Returns:

  • (::Gapic::Rest::TransportOperation)

Raises:

  • (::ArgumentError) 


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 151

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

  verb, uri, query_string_params, body = ServiceStub.transcode_stream_raw_predict_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,
    is_server_streaming: true,
    &block
  )
  ::Gapic::Rest::TransportOperation.new response
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


51
52
53
 
# File 'lib/google/cloud/ai_platform/v1/prediction_service/rest/service_stub.rb', line 51

def universe_domain
  @client_stub.universe_domain
end