Namespace google::cloud::documentai_v1 (2.13.0)

Classes

DocumentProcessorServiceClient

Service to call Document AI to process documents according to the processor's definition.

DocumentProcessorServiceConnection

The DocumentProcessorServiceConnection object for DocumentProcessorServiceClient.

DocumentProcessorServiceConnectionIdempotencyPolicy

Structs

DocumentProcessorServiceBackoffPolicyOption

Use with google::cloud::Options to configure the backoff policy.

DocumentProcessorServiceConnectionIdempotencyPolicyOption

Use with google::cloud::Options to configure which operations are retried.

DocumentProcessorServicePollingPolicyOption

Use with google::cloud::Options to configure the long-running operations polling policy.

DocumentProcessorServiceRetryPolicyOption

Use with google::cloud::Options to configure the retry policy.

Functions

MakeDocumentProcessorServiceConnection(std::string const &, Options)

A factory function to construct an object of type DocumentProcessorServiceConnection.

The returned connection object should not be used directly; instead it should be passed as an argument to the constructor of DocumentProcessorServiceClient.

The optional options argument may be used to configure aspects of the returned DocumentProcessorServiceConnection. Expected options are any of the types in the following option lists:

Parameters
Name Description
location

Sets the prefix for the default EndpointOption value.

options

(optional) Configure the DocumentProcessorServiceConnection created by this function.

Returns
Type Description
std::shared_ptr< DocumentProcessorServiceConnection >

MakeDocumentProcessorServiceConnection(Options)

A backwards-compatible version of the previous factory function.

Unless the service also offers a global endpoint, the default value of the EndpointOption may be useless, in which case it must be overridden.

Parameter
Name Description
options
Returns
Type Description
std::shared_ptr< DocumentProcessorServiceConnection >

MakeDefaultDocumentProcessorServiceConnectionIdempotencyPolicy()

Returns
Type Description
std::unique_ptr< DocumentProcessorServiceConnectionIdempotencyPolicy >

Type Aliases

DocumentProcessorServiceRetryPolicy

Alias Of: ::google::cloud::internal::TraitBasedRetryPolicy< documentai_v1_internal::DocumentProcessorServiceRetryTraits >

DocumentProcessorServiceLimitedTimeRetryPolicy

Alias Of: ::google::cloud::internal::LimitedTimeRetryPolicy< documentai_v1_internal::DocumentProcessorServiceRetryTraits >

DocumentProcessorServiceLimitedErrorCountRetryPolicy

Alias Of: ::google::cloud::internal::LimitedErrorCountRetryPolicy< documentai_v1_internal::DocumentProcessorServiceRetryTraits >

DocumentProcessorServicePolicyOptionList

Alias Of: OptionList< DocumentProcessorServiceRetryPolicyOption, DocumentProcessorServiceBackoffPolicyOption, DocumentProcessorServicePollingPolicyOption, DocumentProcessorServiceConnectionIdempotencyPolicyOption >

The options applicable to DocumentProcessorService.