Class: Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb

Overview

REST service stub for the DocumentService 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
40
41
# File 'lib/google/cloud/document_ai/v1beta3/document_service/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: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#batch_delete_documents(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the batch_delete_documents REST call

Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb', line 171

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

  verb, uri, query_string_params, body = ServiceStub.transcode_batch_delete_documents_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_dataset_schema(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Baseline implementation for the get_dataset_schema REST call

Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb', line 209

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_dataset_schema_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::DocumentAI::V1beta3::DatasetSchema.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_document(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

Baseline implementation for the get_document REST call

Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb', line 133

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

  verb, uri, query_string_params, body = ServiceStub.transcode_get_document_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::DocumentAI::V1beta3::GetDocumentResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#import_documents(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the import_documents REST call

Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb', line 95

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

  verb, uri, query_string_params, body = ServiceStub.transcode_import_documents_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#update_dataset(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Longrunning::Operation

Baseline implementation for the update_dataset REST call

Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb', line 57

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

  verb, uri, query_string_params, body = ServiceStub.transcode_update_dataset_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::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#update_dataset_schema(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Baseline implementation for the update_dataset_schema REST call

Parameters:

Yields:

  • (result, operation)

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError)


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/service_stub.rb', line 247

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

  verb, uri, query_string_params, body = ServiceStub.transcode_update_dataset_schema_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::DocumentAI::V1beta3::DatasetSchema.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end