Class DocumentUnderstandingService.DocumentUnderstandingServiceClient (1.0.0-beta03)

public class DocumentUnderstandingServiceClient : ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient>

Client for DocumentUnderstandingService

Inheritance

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

Inherited Members

ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

DocumentUnderstandingServiceClient(ChannelBase)

public DocumentUnderstandingServiceClient(ChannelBase channel)

Creates a new client for DocumentUnderstandingService

Parameter
Name	Description
`channel`	`ChannelBase` 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
Name	Description
`configuration`	`ClientBase.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
Name	Description
`request`	`BatchProcessDocumentsRequest` 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(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
Name	Description
`request`	`BatchProcessDocumentsRequest` 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(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
Name	Description
`request`	`BatchProcessDocumentsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`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
Name	Description
`request`	`BatchProcessDocumentsRequest` 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 DocumentUnderstandingService.DocumentUnderstandingServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`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
Name	Description
`request`	`ProcessDocumentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`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
Name	Description
`request`	`ProcessDocumentRequest` 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
`Document`	The response received from the server.

ProcessDocumentAsync(ProcessDocumentRequest, CallOptions)

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

Processes a single document.

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

Returns
Type	Description
`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
Name	Description
`request`	`ProcessDocumentRequest` 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<Document>`	The call object.