Class DocumentProcessorService.DocumentProcessorServiceClient (2.0.0)

public class DocumentProcessorServiceClient : ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>

Client for DocumentProcessorService

Inheritance

Object > ClientBase > ClientBase<DocumentProcessorService.DocumentProcessorServiceClient> > DocumentProcessorService.DocumentProcessorServiceClient

Inherited Members

ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

DocumentProcessorServiceClient()

protected DocumentProcessorServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DocumentProcessorServiceClient(CallInvoker)

public DocumentProcessorServiceClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

DocumentProcessorServiceClient(ChannelBase)

public DocumentProcessorServiceClient(ChannelBase channel)

Creates a new client for DocumentProcessorService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration)

protected DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

BatchProcessDocuments(BatchProcessRequest, CallOptions)

public virtual Operation BatchProcessDocuments(BatchProcessRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`BatchProcessRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

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

public virtual Operation BatchProcessDocuments(BatchProcessRequest request, Metadata headers = null, DateTime? deadline = null, 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
Name	Description
`request`	`BatchProcessRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

BatchProcessDocumentsAsync(BatchProcessRequest, CallOptions)

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

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

Parameters
Name	Description
`request`	`BatchProcessRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

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

public virtual AsyncUnaryCall<Operation> BatchProcessDocumentsAsync(BatchProcessRequest request, Metadata headers = null, DateTime? deadline = null, 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
Name	Description
`request`	`BatchProcessRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`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
Type	Description
`Operations.OperationsClient`	A new Operations client for the same target as this client.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override DocumentProcessorService.DocumentProcessorServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`DocumentProcessorService.DocumentProcessorServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.DocumentAI.V1.DocumentProcessorService.DocumentProcessorServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ProcessDocument(ProcessRequest, CallOptions)

public virtual ProcessResponse ProcessDocument(ProcessRequest request, CallOptions options)

Processes a single document.

Parameters
Name	Description
`request`	`ProcessRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ProcessResponse`	The response received from the server.

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

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

Processes a single document.

Parameters
Name	Description
`request`	`ProcessRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ProcessResponse`	The response received from the server.

ProcessDocumentAsync(ProcessRequest, CallOptions)

public virtual AsyncUnaryCall<ProcessResponse> ProcessDocumentAsync(ProcessRequest request, CallOptions options)

Processes a single document.

Parameters
Name	Description
`request`	`ProcessRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ProcessResponse>`	The call object.

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

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

Processes a single document.

Parameters
Name	Description
`request`	`ProcessRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ProcessResponse>`	The call object.

ReviewDocument(ReviewDocumentRequest, CallOptions)

public virtual Operation ReviewDocument(ReviewDocumentRequest request, CallOptions options)

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters
Name	Description
`request`	`ReviewDocumentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ReviewDocument(ReviewDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters
Name	Description
`request`	`ReviewDocumentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

ReviewDocumentAsync(ReviewDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReviewDocumentAsync(ReviewDocumentRequest request, CallOptions options)

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters
Name	Description
`request`	`ReviewDocumentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

ReviewDocumentAsync(ReviewDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters
Name	Description
`request`	`ReviewDocumentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.