Class DocumentUnderstandingService.DocumentUnderstandingServiceClient

Client for DocumentUnderstandingService

Inheritance

System.Object

ClientBase

ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient>

DocumentUnderstandingService.DocumentUnderstandingServiceClient

Inherited Members

ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient>.WithHost(String)

ClientBase.CallInvoker

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DocumentAI.V1Beta2

Assembly: Google.Cloud.DocumentAI.V1Beta2.dll

Syntax

public class DocumentUnderstandingServiceClient : ClientBase<DocumentUnderstandingService.DocumentUnderstandingServiceClient>

Constructors

DocumentUnderstandingServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration

protected DocumentUnderstandingServiceClient()

DocumentUnderstandingServiceClient(CallInvoker)

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

Declaration

public DocumentUnderstandingServiceClient(CallInvoker callInvoker)

Parameters

Type	Name	Description
CallInvoker	callInvoker	The callInvoker to use to make remote calls.

DocumentUnderstandingServiceClient(ChannelBase)

Creates a new client for DocumentUnderstandingService

Declaration

public DocumentUnderstandingServiceClient(ChannelBase channel)

Parameters

Type	Name	Description
ChannelBase	channel	The channel to use to make remote calls.

DocumentUnderstandingServiceClient(ClientBase.ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration

protected DocumentUnderstandingServiceClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration	The client configuration.

Methods

BatchProcessDocuments(BatchProcessDocumentsRequest, CallOptions)

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

Declaration

public virtual Operation BatchProcessDocuments(BatchProcessDocumentsRequest request, CallOptions options)

Parameters

Type	Name	Description
BatchProcessDocumentsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
Operation	The response received from the server.

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

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

Declaration

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

Parameters

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

Returns

Type	Description
Operation	The response received from the server.

BatchProcessDocumentsAsync(BatchProcessDocumentsRequest, CallOptions)

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

Declaration

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

Parameters

Type	Name	Description
BatchProcessDocumentsRequest	request	The request to send to the server.
CallOptions	options	The options for the call.

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

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

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

Declaration

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

Parameters

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

Returns

Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateOperationsClient()

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

Declaration

public virtual Operations.OperationsClient CreateOperationsClient()

Returns

Type	Description
Operations.OperationsClient	A new Operations client for the same target as this client.

NewInstance(ClientBase.ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration

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

Parameters

Type	Name	Description
ClientBase.ClientBaseConfiguration	configuration

Returns

Type	Description
DocumentUnderstandingService.DocumentUnderstandingServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.DocumentAI.V1Beta2.DocumentUnderstandingService.DocumentUnderstandingServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ProcessDocument(ProcessDocumentRequest, CallOptions)

Processes a single document.

Declaration

public virtual Document ProcessDocument(ProcessDocumentRequest request, CallOptions options)

Parameters

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

Returns

Type	Description
Document	The response received from the server.

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

Processes a single document.

Declaration

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

Parameters

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

Returns

Type	Description
Document	The response received from the server.

ProcessDocumentAsync(ProcessDocumentRequest, CallOptions)

Processes a single document.

Declaration

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

Parameters

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

Returns

Type	Description
AsyncUnaryCall<Document>	The call object.

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

Processes a single document.

Declaration

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

Parameters

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

Returns

Type	Description
AsyncUnaryCall<Document>	The call object.