Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::ServiceStub (v0.28.0)

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::ServiceStub.

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

Inherits

Object

Methods

#batch_delete_documents

def batch_delete_documents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the batch_delete_documents REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — 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

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_dataset_schema

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

Baseline implementation for the get_dataset_schema REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::GetDatasetSchemaRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — 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

result (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DocumentAI::V1beta3::DatasetSchema) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_document

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

Baseline implementation for the get_document REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — 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

result (::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#import_documents

def import_documents(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the import_documents REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — 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

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#update_dataset

def update_dataset(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_dataset REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — 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

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#update_dataset_schema

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

Baseline implementation for the update_dataset_schema REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetSchemaRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — 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

result (::Google::Cloud::DocumentAI::V1beta3::DatasetSchema)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::DocumentAI::V1beta3::DatasetSchema) — A result object deserialized from the server's reply

Raises

(::ArgumentError)