Class DocumentProcessorServiceClientImpl (2.0.0-beta01)

public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClient

DocumentProcessorService client wrapper implementation, for convenient use.

Inheritance

Object > DocumentProcessorServiceClient > DocumentProcessorServiceClientImpl

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Remarks

Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Constructors

DocumentProcessorServiceClientImpl(DocumentProcessorService.DocumentProcessorServiceClient, DocumentProcessorServiceSettings, ILogger)

public DocumentProcessorServiceClientImpl(DocumentProcessorService.DocumentProcessorServiceClient grpcClient, DocumentProcessorServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DocumentProcessorService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientDocumentProcessorService.DocumentProcessorServiceClient

The underlying gRPC client.

settingsDocumentProcessorServiceSettings

The base DocumentProcessorServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

BatchProcessDocumentsOperationsClient

public override OperationsClient BatchProcessDocumentsOperationsClient { get; }

The long-running operations client for BatchProcessDocuments.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteProcessorOperationsClient

public override OperationsClient DeleteProcessorOperationsClient { get; }

The long-running operations client for DeleteProcessor.

Property Value
TypeDescription
OperationsClient
Overrides

DisableProcessorOperationsClient

public override OperationsClient DisableProcessorOperationsClient { get; }

The long-running operations client for DisableProcessor.

Property Value
TypeDescription
OperationsClient
Overrides

EnableProcessorOperationsClient

public override OperationsClient EnableProcessorOperationsClient { get; }

The long-running operations client for EnableProcessor.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }

The underlying gRPC DocumentProcessorService client

Property Value
TypeDescription
DocumentProcessorService.DocumentProcessorServiceClient
Overrides

ReviewDocumentOperationsClient

public override OperationsClient ReviewDocumentOperationsClient { get; }

The long-running operations client for ReviewDocument.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

BatchProcessDocuments(BatchProcessRequest, CallSettings)

public override Operation<BatchProcessResponse, BatchProcessMetadata> BatchProcessDocuments(BatchProcessRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<BatchProcessResponse, BatchProcessMetadata>

The RPC response.

Overrides

BatchProcessDocumentsAsync(BatchProcessRequest, CallSettings)

public override async Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(BatchProcessRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<BatchProcessResponse, BatchProcessMetadata>>

A Task containing the RPC response.

Overrides

CreateProcessor(CreateProcessorRequest, CallSettings)

public override Processor CreateProcessor(CreateProcessorRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Overrides

CreateProcessorAsync(CreateProcessorRequest, CallSettings)

public override Task<Processor> CreateProcessorAsync(CreateProcessorRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Processor>

A Task containing the RPC response.

Overrides

DeleteProcessor(DeleteProcessorRequest, CallSettings)

public override Operation<Empty, DeleteProcessorMetadata> DeleteProcessor(DeleteProcessorRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<Empty, DeleteProcessorMetadata>

The RPC response.

Overrides

DeleteProcessorAsync(DeleteProcessorRequest, CallSettings)

public override async Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(DeleteProcessorRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<Empty, DeleteProcessorMetadata>>

A Task containing the RPC response.

Overrides

DisableProcessor(DisableProcessorRequest, CallSettings)

public override Operation<DisableProcessorResponse, DisableProcessorMetadata> DisableProcessor(DisableProcessorRequest request, CallSettings callSettings = null)

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<DisableProcessorResponse, DisableProcessorMetadata>

The RPC response.

Overrides

DisableProcessorAsync(DisableProcessorRequest, CallSettings)

public override async Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>> DisableProcessorAsync(DisableProcessorRequest request, CallSettings callSettings = null)

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>>

A Task containing the RPC response.

Overrides

EnableProcessor(EnableProcessorRequest, CallSettings)

public override Operation<EnableProcessorResponse, EnableProcessorMetadata> EnableProcessor(EnableProcessorRequest request, CallSettings callSettings = null)

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<EnableProcessorResponse, EnableProcessorMetadata>

The RPC response.

Overrides

EnableProcessorAsync(EnableProcessorRequest, CallSettings)

public override async Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>> EnableProcessorAsync(EnableProcessorRequest request, CallSettings callSettings = null)

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>>

A Task containing the RPC response.

Overrides

FetchProcessorTypes(FetchProcessorTypesRequest, CallSettings)

public override FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, CallSettings callSettings = null)

Fetches processor types.

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FetchProcessorTypesResponse

The RPC response.

Overrides

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallSettings)

public override Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(FetchProcessorTypesRequest request, CallSettings callSettings = null)

Fetches processor types.

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<FetchProcessorTypesResponse>

A Task containing the RPC response.

Overrides

ListProcessors(ListProcessorsRequest, CallSettings)

public override PagedEnumerable<ListProcessorsResponse, Processor> ListProcessors(ListProcessorsRequest request, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListProcessorsResponse, Processor>

A pageable sequence of Processor resources.

Overrides

ListProcessorsAsync(ListProcessorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessorsResponse, Processor> ListProcessorsAsync(ListProcessorsRequest request, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListProcessorsResponse, Processor>

A pageable asynchronous sequence of Processor resources.

Overrides

ProcessDocument(ProcessRequest, CallSettings)

public override ProcessResponse ProcessDocument(ProcessRequest request, CallSettings callSettings = null)

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessResponse

The RPC response.

Overrides

ProcessDocumentAsync(ProcessRequest, CallSettings)

public override Task<ProcessResponse> ProcessDocumentAsync(ProcessRequest request, CallSettings callSettings = null)

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ProcessResponse>

A Task containing the RPC response.

Overrides

ReviewDocument(ReviewDocumentRequest, CallSettings)

public override Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> ReviewDocument(ReviewDocumentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestReviewDocumentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>

The RPC response.

Overrides

ReviewDocumentAsync(ReviewDocumentRequest, CallSettings)

public override async Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(ReviewDocumentRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestReviewDocumentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>>

A Task containing the RPC response.

Overrides