Class DocumentProcessorService.DocumentProcessorServiceClient (2.0.0-beta01)

public class DocumentProcessorServiceClient : ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>

Client for DocumentProcessorService

Inheritance

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

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DocumentProcessorServiceClient(ChannelBase)

public DocumentProcessorServiceClient(ChannelBase channel)

Creates a new client for DocumentProcessorService

Parameter
NameDescription
channelChannelBase

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
NameDescription
configurationClientBase.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
NameDescription
requestBatchProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestBatchProcessRequest

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(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
NameDescription
requestBatchProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestBatchProcessRequest

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.

CreateProcessor(CreateProcessorRequest, CallOptions)

public virtual Processor CreateProcessor(CreateProcessorRequest request, CallOptions options)

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters
NameDescription
requestCreateProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Processor

The response received from the server.

CreateProcessor(CreateProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Processor CreateProcessor(CreateProcessorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters
NameDescription
requestCreateProcessorRequest

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
Processor

The response received from the server.

CreateProcessorAsync(CreateProcessorRequest, CallOptions)

public virtual AsyncUnaryCall<Processor> CreateProcessorAsync(CreateProcessorRequest request, CallOptions options)

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters
NameDescription
requestCreateProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Processor>

The call object.

CreateProcessorAsync(CreateProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Processor> CreateProcessorAsync(CreateProcessorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

Parameters
NameDescription
requestCreateProcessorRequest

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<Processor>

The call object.

DeleteProcessor(DeleteProcessorRequest, CallOptions)

public virtual Operation DeleteProcessor(DeleteProcessorRequest request, CallOptions options)

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameters
NameDescription
requestDeleteProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteProcessor(DeleteProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameters
NameDescription
requestDeleteProcessorRequest

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.

DeleteProcessorAsync(DeleteProcessorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteProcessorAsync(DeleteProcessorRequest request, CallOptions options)

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameters
NameDescription
requestDeleteProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteProcessorAsync(DeleteProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

Parameters
NameDescription
requestDeleteProcessorRequest

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.

DisableProcessor(DisableProcessorRequest, CallOptions)

public virtual Operation DisableProcessor(DisableProcessorRequest request, CallOptions options)

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DisableProcessor(DisableProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

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.

DisableProcessorAsync(DisableProcessorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DisableProcessorAsync(DisableProcessorRequest request, CallOptions options)

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DisableProcessorAsync(DisableProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

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.

EnableProcessor(EnableProcessorRequest, CallOptions)

public virtual Operation EnableProcessor(EnableProcessorRequest request, CallOptions options)

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

EnableProcessor(EnableProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

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.

EnableProcessorAsync(EnableProcessorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> EnableProcessorAsync(EnableProcessorRequest request, CallOptions options)

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

EnableProcessorAsync(EnableProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

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.

FetchProcessorTypes(FetchProcessorTypesRequest, CallOptions)

public virtual FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, CallOptions options)

Fetches processor types.

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FetchProcessorTypesResponse

The response received from the server.

FetchProcessorTypes(FetchProcessorTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Fetches processor types.

Parameters
NameDescription
requestFetchProcessorTypesRequest

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
FetchProcessorTypesResponse

The response received from the server.

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallOptions)

public virtual AsyncUnaryCall<FetchProcessorTypesResponse> FetchProcessorTypesAsync(FetchProcessorTypesRequest request, CallOptions options)

Fetches processor types.

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FetchProcessorTypesResponse>

The call object.

FetchProcessorTypesAsync(FetchProcessorTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<FetchProcessorTypesResponse> FetchProcessorTypesAsync(FetchProcessorTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Fetches processor types.

Parameters
NameDescription
requestFetchProcessorTypesRequest

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<FetchProcessorTypesResponse>

The call object.

ListProcessors(ListProcessorsRequest, CallOptions)

public virtual ListProcessorsResponse ListProcessors(ListProcessorsRequest request, CallOptions options)

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListProcessorsResponse

The response received from the server.

ListProcessors(ListProcessorsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListProcessorsResponse ListProcessors(ListProcessorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

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
ListProcessorsResponse

The response received from the server.

ListProcessorsAsync(ListProcessorsRequest, CallOptions)

public virtual AsyncUnaryCall<ListProcessorsResponse> ListProcessorsAsync(ListProcessorsRequest request, CallOptions options)

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorsResponse>

The call object.

ListProcessorsAsync(ListProcessorsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListProcessorsResponse> ListProcessorsAsync(ListProcessorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

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<ListProcessorsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
DocumentProcessorService.DocumentProcessorServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.DocumentAI.V1Beta3.DocumentProcessorService.DocumentProcessorServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ProcessDocument(ProcessRequest, CallOptions)

public virtual ProcessResponse ProcessDocument(ProcessRequest request, CallOptions options)

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestProcessRequest

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
ProcessResponse

The response received from the server.

ProcessDocumentAsync(ProcessRequest, CallOptions)

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

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestProcessRequest

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<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
NameDescription
requestReviewDocumentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestReviewDocumentRequest

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.

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
NameDescription
requestReviewDocumentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestReviewDocumentRequest

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.