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

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

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

Inherits

Object

Methods

#batch_process_documents

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

Baseline implementation for the batch_process_documents REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest) — 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)

#create_processor

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

Baseline implementation for the create_processor REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::CreateProcessorRequest) — 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::Processor)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#delete_processor

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

Baseline implementation for the delete_processor REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::DeleteProcessorRequest) — 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)

#delete_processor_version

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

Baseline implementation for the delete_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::DeleteProcessorVersionRequest) — 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)

#deploy_processor_version

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

Baseline implementation for the deploy_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::DeployProcessorVersionRequest) — 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)

#disable_processor

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

Baseline implementation for the disable_processor REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::DisableProcessorRequest) — 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)

#enable_processor

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

Baseline implementation for the enable_processor REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::EnableProcessorRequest) — 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)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#evaluate_processor_version

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

Baseline implementation for the evaluate_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::EvaluateProcessorVersionRequest) — 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)

#fetch_processor_types

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

Baseline implementation for the fetch_processor_types REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::FetchProcessorTypesRequest) — 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::FetchProcessorTypesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#get_evaluation

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

Baseline implementation for the get_evaluation REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::GetEvaluationRequest) — 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::Evaluation)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#get_processor

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

Baseline implementation for the get_processor REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::GetProcessorRequest) — 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::Processor)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#get_processor_type

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

Baseline implementation for the get_processor_type REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::GetProcessorTypeRequest) — 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::ProcessorType)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#get_processor_version

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

Baseline implementation for the get_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::GetProcessorVersionRequest) — 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::ProcessorVersion)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#import_processor_version

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

Baseline implementation for the import_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ImportProcessorVersionRequest) — 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:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#list_evaluations

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

Baseline implementation for the list_evaluations REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ListEvaluationsRequest) — 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::ListEvaluationsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#list_processor_types

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

Baseline implementation for the list_processor_types REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ListProcessorTypesRequest) — 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::ListProcessorTypesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#list_processor_versions

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

Baseline implementation for the list_processor_versions REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ListProcessorVersionsRequest) — 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::ListProcessorVersionsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#list_processors

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

Baseline implementation for the list_processors REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ListProcessorsRequest) — 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::ListProcessorsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#process_document

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

Baseline implementation for the process_document REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ProcessRequest) — 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::ProcessResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#review_document

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

Baseline implementation for the review_document REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest) — 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)

#set_default_processor_version

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

Baseline implementation for the set_default_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::SetDefaultProcessorVersionRequest) — 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)

#train_processor_version

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

Baseline implementation for the train_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::TrainProcessorVersionRequest) — 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)

#undeploy_processor_version

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

Baseline implementation for the undeploy_processor_version REST call

Parameters

request_pb (::Google::Cloud::DocumentAI::V1beta3::UndeployProcessorVersionRequest) — 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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)