Cloud Document AI v1 API - Class DocumentProcessorServiceClientImpl (3.4.0)

public sealed class DocumentProcessorServiceClientImpl : DocumentProcessorServiceClient

Reference documentation and code samples for the Cloud Document AI v1 API class DocumentProcessorServiceClientImpl.

DocumentProcessorService client wrapper implementation, for convenient use.

Inheritance

Object > DocumentProcessorServiceClient > DocumentProcessorServiceClientImpl

Inherited Members

DocumentProcessorServiceClient.DefaultEndpoint

DocumentProcessorServiceClient.DefaultScopes

DocumentProcessorServiceClient.ServiceMetadata

DocumentProcessorServiceClient.CreateAsync(CancellationToken)

DocumentProcessorServiceClient.Create()

DocumentProcessorServiceClient.ShutdownDefaultChannelsAsync()

DocumentProcessorServiceClient.ProcessDocumentAsync(ProcessRequest, CancellationToken)

DocumentProcessorServiceClient.ProcessDocument(String, CallSettings)

DocumentProcessorServiceClient.ProcessDocumentAsync(String, CallSettings)

DocumentProcessorServiceClient.ProcessDocumentAsync(String, CancellationToken)

DocumentProcessorServiceClient.ProcessDocument(IResourceName, CallSettings)

DocumentProcessorServiceClient.ProcessDocumentAsync(IResourceName, CallSettings)

DocumentProcessorServiceClient.ProcessDocumentAsync(IResourceName, CancellationToken)

DocumentProcessorServiceClient.BatchProcessDocumentsAsync(BatchProcessRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceBatchProcessDocuments(String, CallSettings)

DocumentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(String, CallSettings)

DocumentProcessorServiceClient.BatchProcessDocuments(String, CallSettings)

DocumentProcessorServiceClient.BatchProcessDocumentsAsync(String, CallSettings)

DocumentProcessorServiceClient.BatchProcessDocumentsAsync(String, CancellationToken)

DocumentProcessorServiceClient.BatchProcessDocuments(IResourceName, CallSettings)

DocumentProcessorServiceClient.BatchProcessDocumentsAsync(IResourceName, CallSettings)

DocumentProcessorServiceClient.BatchProcessDocumentsAsync(IResourceName, CancellationToken)

DocumentProcessorServiceClient.FetchProcessorTypesAsync(FetchProcessorTypesRequest, CancellationToken)

DocumentProcessorServiceClient.FetchProcessorTypes(String, CallSettings)

DocumentProcessorServiceClient.FetchProcessorTypesAsync(String, CallSettings)

DocumentProcessorServiceClient.FetchProcessorTypesAsync(String, CancellationToken)

DocumentProcessorServiceClient.FetchProcessorTypes(LocationName, CallSettings)

DocumentProcessorServiceClient.FetchProcessorTypesAsync(LocationName, CallSettings)

DocumentProcessorServiceClient.FetchProcessorTypesAsync(LocationName, CancellationToken)

DocumentProcessorServiceClient.ListProcessorTypes(String, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorTypesAsync(String, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorTypes(LocationName, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorTypesAsync(LocationName, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.GetProcessorTypeAsync(GetProcessorTypeRequest, CancellationToken)

DocumentProcessorServiceClient.GetProcessorType(String, CallSettings)

DocumentProcessorServiceClient.GetProcessorTypeAsync(String, CallSettings)

DocumentProcessorServiceClient.GetProcessorTypeAsync(String, CancellationToken)

DocumentProcessorServiceClient.GetProcessorType(ProcessorTypeName, CallSettings)

DocumentProcessorServiceClient.GetProcessorTypeAsync(ProcessorTypeName, CallSettings)

DocumentProcessorServiceClient.GetProcessorTypeAsync(ProcessorTypeName, CancellationToken)

DocumentProcessorServiceClient.ListProcessors(String, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorsAsync(String, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessors(LocationName, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorsAsync(LocationName, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.GetProcessorAsync(GetProcessorRequest, CancellationToken)

DocumentProcessorServiceClient.GetProcessor(String, CallSettings)

DocumentProcessorServiceClient.GetProcessorAsync(String, CallSettings)

DocumentProcessorServiceClient.GetProcessorAsync(String, CancellationToken)

DocumentProcessorServiceClient.GetProcessor(ProcessorName, CallSettings)

DocumentProcessorServiceClient.GetProcessorAsync(ProcessorName, CallSettings)

DocumentProcessorServiceClient.GetProcessorAsync(ProcessorName, CancellationToken)

DocumentProcessorServiceClient.GetProcessorVersionAsync(GetProcessorVersionRequest, CancellationToken)

DocumentProcessorServiceClient.GetProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.GetProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.GetProcessorVersionAsync(String, CancellationToken)

DocumentProcessorServiceClient.GetProcessorVersion(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.GetProcessorVersionAsync(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.GetProcessorVersionAsync(ProcessorVersionName, CancellationToken)

DocumentProcessorServiceClient.ListProcessorVersions(String, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorVersionsAsync(String, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorVersions(ProcessorName, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.ListProcessorVersionsAsync(ProcessorName, String, Nullable<Int32>, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceDeleteProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorVersionAsync(String, CancellationToken)

DocumentProcessorServiceClient.DeleteProcessorVersion(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorVersionAsync(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorVersionAsync(ProcessorVersionName, CancellationToken)

DocumentProcessorServiceClient.DeployProcessorVersionAsync(DeployProcessorVersionRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceDeployProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.DeployProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.DeployProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.DeployProcessorVersionAsync(String, CancellationToken)

DocumentProcessorServiceClient.DeployProcessorVersion(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.DeployProcessorVersionAsync(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.DeployProcessorVersionAsync(ProcessorVersionName, CancellationToken)

DocumentProcessorServiceClient.UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceUndeployProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.PollOnceUndeployProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.UndeployProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.UndeployProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.UndeployProcessorVersionAsync(String, CancellationToken)

DocumentProcessorServiceClient.UndeployProcessorVersion(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.UndeployProcessorVersionAsync(ProcessorVersionName, CallSettings)

DocumentProcessorServiceClient.UndeployProcessorVersionAsync(ProcessorVersionName, CancellationToken)

DocumentProcessorServiceClient.CreateProcessorAsync(CreateProcessorRequest, CancellationToken)

DocumentProcessorServiceClient.CreateProcessor(String, Processor, CallSettings)

DocumentProcessorServiceClient.CreateProcessorAsync(String, Processor, CallSettings)

DocumentProcessorServiceClient.CreateProcessorAsync(String, Processor, CancellationToken)

DocumentProcessorServiceClient.CreateProcessor(LocationName, Processor, CallSettings)

DocumentProcessorServiceClient.CreateProcessorAsync(LocationName, Processor, CallSettings)

DocumentProcessorServiceClient.CreateProcessorAsync(LocationName, Processor, CancellationToken)

DocumentProcessorServiceClient.DeleteProcessorAsync(DeleteProcessorRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceDeleteProcessor(String, CallSettings)

DocumentProcessorServiceClient.PollOnceDeleteProcessorAsync(String, CallSettings)

DocumentProcessorServiceClient.DeleteProcessor(String, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorAsync(String, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorAsync(String, CancellationToken)

DocumentProcessorServiceClient.DeleteProcessor(ProcessorName, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorAsync(ProcessorName, CallSettings)

DocumentProcessorServiceClient.DeleteProcessorAsync(ProcessorName, CancellationToken)

DocumentProcessorServiceClient.EnableProcessorAsync(EnableProcessorRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceEnableProcessor(String, CallSettings)

DocumentProcessorServiceClient.PollOnceEnableProcessorAsync(String, CallSettings)

DocumentProcessorServiceClient.DisableProcessorAsync(DisableProcessorRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceDisableProcessor(String, CallSettings)

DocumentProcessorServiceClient.PollOnceDisableProcessorAsync(String, CallSettings)

DocumentProcessorServiceClient.SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceSetDefaultProcessorVersion(String, CallSettings)

DocumentProcessorServiceClient.PollOnceSetDefaultProcessorVersionAsync(String, CallSettings)

DocumentProcessorServiceClient.ReviewDocumentAsync(ReviewDocumentRequest, CancellationToken)

DocumentProcessorServiceClient.PollOnceReviewDocument(String, CallSettings)

DocumentProcessorServiceClient.PollOnceReviewDocumentAsync(String, CallSettings)

DocumentProcessorServiceClient.ReviewDocument(String, CallSettings)

DocumentProcessorServiceClient.ReviewDocumentAsync(String, CallSettings)

DocumentProcessorServiceClient.ReviewDocumentAsync(String, CancellationToken)

DocumentProcessorServiceClient.ReviewDocument(HumanReviewConfigName, CallSettings)

DocumentProcessorServiceClient.ReviewDocumentAsync(HumanReviewConfigName, CallSettings)

DocumentProcessorServiceClient.ReviewDocumentAsync(HumanReviewConfigName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.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
Name	Description
`grpcClient`	`DocumentProcessorService.DocumentProcessorServiceClient` The underlying gRPC client.
`settings`	`DocumentProcessorServiceSettings` The base DocumentProcessorServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

BatchProcessDocumentsOperationsClient

public override OperationsClient BatchProcessDocumentsOperationsClient { get; }

The long-running operations client for BatchProcessDocuments.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.BatchProcessDocumentsOperationsClient

DeleteProcessorOperationsClient

public override OperationsClient DeleteProcessorOperationsClient { get; }

The long-running operations client for DeleteProcessor.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.DeleteProcessorOperationsClient

DeleteProcessorVersionOperationsClient

public override OperationsClient DeleteProcessorVersionOperationsClient { get; }

The long-running operations client for DeleteProcessorVersion.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.DeleteProcessorVersionOperationsClient

DeployProcessorVersionOperationsClient

public override OperationsClient DeployProcessorVersionOperationsClient { get; }

The long-running operations client for DeployProcessorVersion.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.DeployProcessorVersionOperationsClient

DisableProcessorOperationsClient

public override OperationsClient DisableProcessorOperationsClient { get; }

The long-running operations client for DisableProcessor.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.DisableProcessorOperationsClient

EnableProcessorOperationsClient

public override OperationsClient EnableProcessorOperationsClient { get; }

The long-running operations client for EnableProcessor.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.EnableProcessorOperationsClient

GrpcClient

public override DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }

The underlying gRPC DocumentProcessorService client

Property Value
Type	Description
`DocumentProcessorService.DocumentProcessorServiceClient`

Overrides

DocumentProcessorServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

DocumentProcessorServiceClient.LocationsClient

ReviewDocumentOperationsClient

public override OperationsClient ReviewDocumentOperationsClient { get; }

The long-running operations client for ReviewDocument.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.ReviewDocumentOperationsClient

SetDefaultProcessorVersionOperationsClient

public override OperationsClient SetDefaultProcessorVersionOperationsClient { get; }

The long-running operations client for SetDefaultProcessorVersion.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.SetDefaultProcessorVersionOperationsClient

UndeployProcessorVersionOperationsClient

public override OperationsClient UndeployProcessorVersionOperationsClient { get; }

The long-running operations client for UndeployProcessorVersion.

Property Value
Type	Description
`OperationsClient`

Overrides

DocumentProcessorServiceClient.UndeployProcessorVersionOperationsClient

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
Name	Description
`request`	`BatchProcessRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<BatchProcessResponse, BatchProcessMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.BatchProcessDocuments(BatchProcessRequest, CallSettings)

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
Name	Description
`request`	`BatchProcessRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<BatchProcessResponse, BatchProcessMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.BatchProcessDocumentsAsync(BatchProcessRequest, CallSettings)

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
Name	Description
`request`	`CreateProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Processor`	The RPC response.

Overrides

DocumentProcessorServiceClient.CreateProcessor(CreateProcessorRequest, CallSettings)

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
Name	Description
`request`	`CreateProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Processor>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.CreateProcessorAsync(CreateProcessorRequest, CallSettings)

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
Name	Description
`request`	`DeleteProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, DeleteProcessorMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.DeleteProcessor(DeleteProcessorRequest, CallSettings)

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
Name	Description
`request`	`DeleteProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, DeleteProcessorMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.DeleteProcessorAsync(DeleteProcessorRequest, CallSettings)

DeleteProcessorVersion(DeleteProcessorVersionRequest, CallSettings)

public override Operation<Empty, DeleteProcessorVersionMetadata> DeleteProcessorVersion(DeleteProcessorVersionRequest request, CallSettings callSettings = null)

Deletes the processor version, all artifacts under the processor version will be deleted.

Parameters
Name	Description
`request`	`DeleteProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, DeleteProcessorVersionMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.DeleteProcessorVersion(DeleteProcessorVersionRequest, CallSettings)

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CallSettings)

public override async Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(DeleteProcessorVersionRequest request, CallSettings callSettings = null)

Deletes the processor version, all artifacts under the processor version will be deleted.

Parameters
Name	Description
`request`	`DeleteProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, DeleteProcessorVersionMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CallSettings)

DeployProcessorVersion(DeployProcessorVersionRequest, CallSettings)

public override Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> DeployProcessorVersion(DeployProcessorVersionRequest request, CallSettings callSettings = null)

Deploys the processor version.

Parameters
Name	Description
`request`	`DeployProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.DeployProcessorVersion(DeployProcessorVersionRequest, CallSettings)

DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallSettings)

public override async Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(DeployProcessorVersionRequest request, CallSettings callSettings = null)

Deploys the processor version.

Parameters
Name	Description
`request`	`DeployProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallSettings)

DisableProcessor(DisableProcessorRequest, CallSettings)

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

Disables a processor

Parameters
Name	Description
`request`	`DisableProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<DisableProcessorResponse, DisableProcessorMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.DisableProcessor(DisableProcessorRequest, CallSettings)

DisableProcessorAsync(DisableProcessorRequest, CallSettings)

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

Disables a processor

Parameters
Name	Description
`request`	`DisableProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.DisableProcessorAsync(DisableProcessorRequest, CallSettings)

EnableProcessor(EnableProcessorRequest, CallSettings)

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

Enables a processor

Parameters
Name	Description
`request`	`EnableProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<EnableProcessorResponse, EnableProcessorMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.EnableProcessor(EnableProcessorRequest, CallSettings)

EnableProcessorAsync(EnableProcessorRequest, CallSettings)

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

Enables a processor

Parameters
Name	Description
`request`	`EnableProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.EnableProcessorAsync(EnableProcessorRequest, CallSettings)

FetchProcessorTypes(FetchProcessorTypesRequest, CallSettings)

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

Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.

Parameters
Name	Description
`request`	`FetchProcessorTypesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`FetchProcessorTypesResponse`	The RPC response.

Overrides

DocumentProcessorServiceClient.FetchProcessorTypes(FetchProcessorTypesRequest, CallSettings)

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallSettings)

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

Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.

Parameters
Name	Description
`request`	`FetchProcessorTypesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<FetchProcessorTypesResponse>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallSettings)

GetProcessor(GetProcessorRequest, CallSettings)

public override Processor GetProcessor(GetProcessorRequest request, CallSettings callSettings = null)

Gets a processor detail.

Parameters
Name	Description
`request`	`GetProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Processor`	The RPC response.

Overrides

DocumentProcessorServiceClient.GetProcessor(GetProcessorRequest, CallSettings)

GetProcessorAsync(GetProcessorRequest, CallSettings)

public override Task<Processor> GetProcessorAsync(GetProcessorRequest request, CallSettings callSettings = null)

Gets a processor detail.

Parameters
Name	Description
`request`	`GetProcessorRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Processor>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.GetProcessorAsync(GetProcessorRequest, CallSettings)

GetProcessorType(GetProcessorTypeRequest, CallSettings)

public override ProcessorType GetProcessorType(GetProcessorTypeRequest request, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
Name	Description
`request`	`GetProcessorTypeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ProcessorType`	The RPC response.

Overrides

DocumentProcessorServiceClient.GetProcessorType(GetProcessorTypeRequest, CallSettings)

GetProcessorTypeAsync(GetProcessorTypeRequest, CallSettings)

public override Task<ProcessorType> GetProcessorTypeAsync(GetProcessorTypeRequest request, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
Name	Description
`request`	`GetProcessorTypeRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<ProcessorType>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.GetProcessorTypeAsync(GetProcessorTypeRequest, CallSettings)

GetProcessorVersion(GetProcessorVersionRequest, CallSettings)

public override ProcessorVersion GetProcessorVersion(GetProcessorVersionRequest request, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
Name	Description
`request`	`GetProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ProcessorVersion`	The RPC response.

Overrides

DocumentProcessorServiceClient.GetProcessorVersion(GetProcessorVersionRequest, CallSettings)

GetProcessorVersionAsync(GetProcessorVersionRequest, CallSettings)

public override Task<ProcessorVersion> GetProcessorVersionAsync(GetProcessorVersionRequest request, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
Name	Description
`request`	`GetProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<ProcessorVersion>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.GetProcessorVersionAsync(GetProcessorVersionRequest, CallSettings)

ListProcessors(ListProcessorsRequest, CallSettings)

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

Lists all processors which belong to this project.

Parameters
Name	Description
`request`	`ListProcessorsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListProcessorsResponse, Processor>`	A pageable sequence of Processor resources.

Overrides

DocumentProcessorServiceClient.ListProcessors(ListProcessorsRequest, CallSettings)

ListProcessorsAsync(ListProcessorsRequest, CallSettings)

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

Lists all processors which belong to this project.

Parameters
Name	Description
`request`	`ListProcessorsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListProcessorsResponse, Processor>`	A pageable asynchronous sequence of Processor resources.

Overrides

DocumentProcessorServiceClient.ListProcessorsAsync(ListProcessorsRequest, CallSettings)

ListProcessorTypes(ListProcessorTypesRequest, CallSettings)

public override PagedEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypes(ListProcessorTypesRequest request, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
Name	Description
`request`	`ListProcessorTypesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListProcessorTypesResponse, ProcessorType>`	A pageable sequence of ProcessorType resources.

Overrides

DocumentProcessorServiceClient.ListProcessorTypes(ListProcessorTypesRequest, CallSettings)

ListProcessorTypesAsync(ListProcessorTypesRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypesAsync(ListProcessorTypesRequest request, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
Name	Description
`request`	`ListProcessorTypesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType>`	A pageable asynchronous sequence of ProcessorType resources.

Overrides

DocumentProcessorServiceClient.ListProcessorTypesAsync(ListProcessorTypesRequest, CallSettings)

ListProcessorVersions(ListProcessorVersionsRequest, CallSettings)

public override PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersions(ListProcessorVersionsRequest request, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
Name	Description
`request`	`ListProcessorVersionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion>`	A pageable sequence of ProcessorVersion resources.

Overrides

DocumentProcessorServiceClient.ListProcessorVersions(ListProcessorVersionsRequest, CallSettings)

ListProcessorVersionsAsync(ListProcessorVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersionsAsync(ListProcessorVersionsRequest request, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
Name	Description
`request`	`ListProcessorVersionsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion>`	A pageable asynchronous sequence of ProcessorVersion resources.

Overrides

DocumentProcessorServiceClient.ListProcessorVersionsAsync(ListProcessorVersionsRequest, CallSettings)

ProcessDocument(ProcessRequest, CallSettings)

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

Processes a single document.

Parameters
Name	Description
`request`	`ProcessRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ProcessResponse`	The RPC response.

Overrides

DocumentProcessorServiceClient.ProcessDocument(ProcessRequest, CallSettings)

ProcessDocumentAsync(ProcessRequest, CallSettings)

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

Processes a single document.

Parameters
Name	Description
`request`	`ProcessRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<ProcessResponse>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.ProcessDocumentAsync(ProcessRequest, CallSettings)

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
Name	Description
`request`	`ReviewDocumentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.ReviewDocument(ReviewDocumentRequest, CallSettings)

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
Name	Description
`request`	`ReviewDocumentRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.ReviewDocumentAsync(ReviewDocumentRequest, CallSettings)

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, CallSettings)

public override Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata> SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, CallSettings callSettings = null)

Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].

Parameters
Name	Description
`request`	`SetDefaultProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, CallSettings)

SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CallSettings)

public override async Task<Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>> SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`SetDefaultProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CallSettings)

UndeployProcessorVersion(UndeployProcessorVersionRequest, CallSettings)

public override Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata> UndeployProcessorVersion(UndeployProcessorVersionRequest request, CallSettings callSettings = null)

Undeploys the processor version.

Parameters
Name	Description
`request`	`UndeployProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata>`	The RPC response.

Overrides

DocumentProcessorServiceClient.UndeployProcessorVersion(UndeployProcessorVersionRequest, CallSettings)

UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CallSettings)

public override async Task<Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata>> UndeployProcessorVersionAsync(UndeployProcessorVersionRequest request, CallSettings callSettings = null)

Undeploys the processor version.

Parameters
Name	Description
`request`	`UndeployProcessorVersionRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata>>`	A Task containing the RPC response.

Overrides

DocumentProcessorServiceClient.UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CallSettings)