Class DocumentUnderstandingService.DocumentUnderstandingServiceClient (1.0.0-beta03)

Stay organized with collections Save and categorize content based on your preferences.
public class DocumentUnderstandingServiceClient : ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient>

Client for DocumentUnderstandingService

Inheritance

Object > ClientBase > ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient> > DocumentUnderstandingService.DocumentUnderstandingServiceClient

Namespace

Google.Cloud.DocumentAI.V1Beta2

Assembly

Google.Cloud.DocumentAI.V1Beta2.dll

Constructors

DocumentUnderstandingServiceClient()

protected DocumentUnderstandingServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DocumentUnderstandingServiceClient(CallInvoker)

public DocumentUnderstandingServiceClient(CallInvoker callInvoker)

Creates a new client for DocumentUnderstandingService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DocumentUnderstandingServiceClient(ChannelBase)

public DocumentUnderstandingServiceClient(ChannelBase channel)

Creates a new client for DocumentUnderstandingService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

DocumentUnderstandingServiceClient(ClientBase.ClientBaseConfiguration)

protected DocumentUnderstandingServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

BatchProcessDocuments(BatchProcessDocumentsRequest, CallOptions)

public virtual Operation BatchProcessDocuments(BatchProcessDocumentsRequest request, CallOptions options)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameters
NameDescription
requestBatchProcessDocumentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchProcessDocuments(BatchProcessDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation BatchProcessDocuments(BatchProcessDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameters
NameDescription
requestBatchProcessDocumentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchProcessDocumentsAsync(BatchProcessDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchProcessDocumentsAsync(BatchProcessDocumentsRequest request, CallOptions options)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameters
NameDescription
requestBatchProcessDocumentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

BatchProcessDocumentsAsync(BatchProcessDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> BatchProcessDocumentsAsync(BatchProcessDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameters
NameDescription
requestBatchProcessDocumentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override DocumentUnderstandingService.DocumentUnderstandingServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
DocumentUnderstandingService.DocumentUnderstandingServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DocumentAI.V1Beta2.DocumentUnderstandingService.DocumentUnderstandingServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ProcessDocument(ProcessDocumentRequest, CallOptions)

public virtual Document ProcessDocument(ProcessDocumentRequest request, CallOptions options)

Processes a single document.

Parameters
NameDescription
requestProcessDocumentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Document

The response received from the server.

ProcessDocument(ProcessDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Document ProcessDocument(ProcessDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Processes a single document.

Parameters
NameDescription
requestProcessDocumentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Document

The response received from the server.

ProcessDocumentAsync(ProcessDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<Document> ProcessDocumentAsync(ProcessDocumentRequest request, CallOptions options)

Processes a single document.

Parameters
NameDescription
requestProcessDocumentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Document>

The call object.

ProcessDocumentAsync(ProcessDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Document> ProcessDocumentAsync(ProcessDocumentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Processes a single document.

Parameters
NameDescription
requestProcessDocumentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Document>

The call object.