Cloud Document AI v1beta3 API - Class DocumentProcessorService.DocumentProcessorServiceClient (2.0.0-beta18)

Version 2.0.0-beta18

• 2.0.0-beta23 (latest)
• 2.0.0-beta22
• 1.0.0-beta04

public class DocumentProcessorService.DocumentProcessorServiceClient : ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>

Reference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentProcessorService.DocumentProcessorServiceClient.

Client for DocumentProcessorService

Inheritance

object > ClientBase > ClientBaseDocumentProcessorServiceDocumentProcessorServiceClient > DocumentProcessorService.DocumentProcessorServiceClient

Inherited Members

ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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

DocumentProcessorServiceClient(ChannelBase)

public DocumentProcessorServiceClient(ChannelBase channel)

Creates a new client for DocumentProcessorService

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

DocumentProcessorServiceClient(ClientBaseConfiguration)

protected DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration 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
Name	Description
request	BatchProcessRequest 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(BatchProcessRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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(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
Name	Description
request	BatchProcessRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

BatchProcessDocumentsAsync(BatchProcessRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type	Description
OperationsOperationsClient	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 [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation.

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

Returns
Type	Description
Processor	The response received from the server.

CreateProcessor(CreateProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation.

Parameters
Name	Description
request	CreateProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Processor	The response received from the server.

CreateProcessorAsync(CreateProcessorRequest, CallOptions)

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

Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation.

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

Returns
Type	Description
AsyncUnaryCallProcessor	The call object.

CreateProcessorAsync(CreateProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Creates a processor from the [ProcessorType][google.cloud.documentai.v1beta3.ProcessorType] provided. The processor will be at ENABLED state by default after its creation.

Parameters
Name	Description
request	CreateProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallProcessor	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
Name	Description
request	DeleteProcessorRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

DeleteProcessor(DeleteProcessorRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteProcessorAsync(DeleteProcessorRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

DeleteProcessorVersion(DeleteProcessorVersionRequest, CallOptions)

public virtual Operation DeleteProcessorVersion(DeleteProcessorVersionRequest request, CallOptions options)

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

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

Returns
Type	Description
Operation	The response received from the server.

DeleteProcessorVersion(DeleteProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	DeleteProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteProcessorVersionAsync(DeleteProcessorVersionRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	DeleteProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

DeployProcessorVersion(DeployProcessorVersionRequest, CallOptions)

public virtual Operation DeployProcessorVersion(DeployProcessorVersionRequest request, CallOptions options)

Deploys the processor version.

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

Returns
Type	Description
Operation	The response received from the server.

DeployProcessorVersion(DeployProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Deploys the processor version.

Parameters
Name	Description
request	DeployProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeployProcessorVersionAsync(DeployProcessorVersionRequest request, CallOptions options)

Deploys the processor version.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeployProcessorVersionAsync(DeployProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Deploys the processor version.

Parameters
Name	Description
request	DeployProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

DisableProcessor(DisableProcessorRequest, CallOptions)

public virtual Operation DisableProcessor(DisableProcessorRequest request, CallOptions options)

Disables a processor

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

Returns
Type	Description
Operation	The response received from the server.

DisableProcessor(DisableProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Disables a processor

Parameters
Name	Description
request	DisableProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

DisableProcessorAsync(DisableProcessorRequest, CallOptions)

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

Disables a processor

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DisableProcessorAsync(DisableProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Disables a processor

Parameters
Name	Description
request	DisableProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

EnableProcessor(EnableProcessorRequest, CallOptions)

public virtual Operation EnableProcessor(EnableProcessorRequest request, CallOptions options)

Enables a processor

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

Returns
Type	Description
Operation	The response received from the server.

EnableProcessor(EnableProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Enables a processor

Parameters
Name	Description
request	EnableProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

EnableProcessorAsync(EnableProcessorRequest, CallOptions)

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

Enables a processor

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

EnableProcessorAsync(EnableProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Enables a processor

Parameters
Name	Description
request	EnableProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

EvaluateProcessorVersion(EvaluateProcessorVersionRequest, CallOptions)

public virtual Operation EvaluateProcessorVersion(EvaluateProcessorVersionRequest request, CallOptions options)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

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

Returns
Type	Description
Operation	The response received from the server.

EvaluateProcessorVersion(EvaluateProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
Name	Description
request	EvaluateProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest request, CallOptions options)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
Name	Description
request	EvaluateProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

FetchProcessorTypes(FetchProcessorTypesRequest, CallOptions)

public virtual FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, CallOptions options)

Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.

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

Returns
Type	Description
FetchProcessorTypesResponse	The response received from the server.

FetchProcessorTypes(FetchProcessorTypesRequest, Metadata, DateTime?, CancellationToken)

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

Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.

Parameters
Name	Description
request	FetchProcessorTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
FetchProcessorTypesResponse	The response received from the server.

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallOptions)

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

Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.

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

Returns
Type	Description
AsyncUnaryCallFetchProcessorTypesResponse	The call object.

FetchProcessorTypesAsync(FetchProcessorTypesRequest, Metadata, DateTime?, CancellationToken)

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

Fetches processor types. Note that we don't use [ListProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.ListProcessorTypes] here, because it isn't paginated.

Parameters
Name	Description
request	FetchProcessorTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallFetchProcessorTypesResponse	The call object.

GetEvaluation(GetEvaluationRequest, CallOptions)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, CallOptions options)

Retrieves a specific evaluation.

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

Returns
Type	Description
Evaluation	The response received from the server.

GetEvaluation(GetEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a specific evaluation.

Parameters
Name	Description
request	GetEvaluationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Evaluation	The response received from the server.

GetEvaluationAsync(GetEvaluationRequest, CallOptions)

public virtual AsyncUnaryCall<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallOptions options)

Retrieves a specific evaluation.

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

Returns
Type	Description
AsyncUnaryCallEvaluation	The call object.

GetEvaluationAsync(GetEvaluationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a specific evaluation.

Parameters
Name	Description
request	GetEvaluationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallEvaluation	The call object.

GetProcessor(GetProcessorRequest, CallOptions)

public virtual Processor GetProcessor(GetProcessorRequest request, CallOptions options)

Gets a processor detail.

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

Returns
Type	Description
Processor	The response received from the server.

GetProcessor(GetProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Gets a processor detail.

Parameters
Name	Description
request	GetProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Processor	The response received from the server.

GetProcessorAsync(GetProcessorRequest, CallOptions)

public virtual AsyncUnaryCall<Processor> GetProcessorAsync(GetProcessorRequest request, CallOptions options)

Gets a processor detail.

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

Returns
Type	Description
AsyncUnaryCallProcessor	The call object.

GetProcessorAsync(GetProcessorRequest, Metadata, DateTime?, CancellationToken)

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

Gets a processor detail.

Parameters
Name	Description
request	GetProcessorRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallProcessor	The call object.

GetProcessorType(GetProcessorTypeRequest, CallOptions)

public virtual ProcessorType GetProcessorType(GetProcessorTypeRequest request, CallOptions options)

Gets a processor type detail.

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

Returns
Type	Description
ProcessorType	The response received from the server.

GetProcessorType(GetProcessorTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual ProcessorType GetProcessorType(GetProcessorTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a processor type detail.

Parameters
Name	Description
request	GetProcessorTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ProcessorType	The response received from the server.

GetProcessorTypeAsync(GetProcessorTypeRequest, CallOptions)

public virtual AsyncUnaryCall<ProcessorType> GetProcessorTypeAsync(GetProcessorTypeRequest request, CallOptions options)

Gets a processor type detail.

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

Returns
Type	Description
AsyncUnaryCallProcessorType	The call object.

GetProcessorTypeAsync(GetProcessorTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ProcessorType> GetProcessorTypeAsync(GetProcessorTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a processor type detail.

Parameters
Name	Description
request	GetProcessorTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallProcessorType	The call object.

GetProcessorVersion(GetProcessorVersionRequest, CallOptions)

public virtual ProcessorVersion GetProcessorVersion(GetProcessorVersionRequest request, CallOptions options)

Gets a processor version detail.

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

Returns
Type	Description
ProcessorVersion	The response received from the server.

GetProcessorVersion(GetProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual ProcessorVersion GetProcessorVersion(GetProcessorVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a processor version detail.

Parameters
Name	Description
request	GetProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ProcessorVersion	The response received from the server.

GetProcessorVersionAsync(GetProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<ProcessorVersion> GetProcessorVersionAsync(GetProcessorVersionRequest request, CallOptions options)

Gets a processor version detail.

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

Returns
Type	Description
AsyncUnaryCallProcessorVersion	The call object.

GetProcessorVersionAsync(GetProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ProcessorVersion> GetProcessorVersionAsync(GetProcessorVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a processor version detail.

Parameters
Name	Description
request	GetProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallProcessorVersion	The call object.

ImportProcessorVersion(ImportProcessorVersionRequest, CallOptions)

public virtual Operation ImportProcessorVersion(ImportProcessorVersionRequest request, CallOptions options)

Imports a processor version from source processor version.

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

Returns
Type	Description
Operation	The response received from the server.

ImportProcessorVersion(ImportProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Imports a processor version from source processor version.

Parameters
Name	Description
request	ImportProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

ImportProcessorVersionAsync(ImportProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportProcessorVersionAsync(ImportProcessorVersionRequest request, CallOptions options)

Imports a processor version from source processor version.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportProcessorVersionAsync(ImportProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Imports a processor version from source processor version.

Parameters
Name	Description
request	ImportProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

ListEvaluations(ListEvaluationsRequest, CallOptions)

public virtual ListEvaluationsResponse ListEvaluations(ListEvaluationsRequest request, CallOptions options)

Retrieves a set of evaluations for a given processor version.

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

Returns
Type	Description
ListEvaluationsResponse	The response received from the server.

ListEvaluations(ListEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEvaluationsResponse ListEvaluations(ListEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a set of evaluations for a given processor version.

Parameters
Name	Description
request	ListEvaluationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ListEvaluationsResponse	The response received from the server.

ListEvaluationsAsync(ListEvaluationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEvaluationsResponse> ListEvaluationsAsync(ListEvaluationsRequest request, CallOptions options)

Retrieves a set of evaluations for a given processor version.

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

Returns
Type	Description
AsyncUnaryCallListEvaluationsResponse	The call object.

ListEvaluationsAsync(ListEvaluationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEvaluationsResponse> ListEvaluationsAsync(ListEvaluationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a set of evaluations for a given processor version.

Parameters
Name	Description
request	ListEvaluationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallListEvaluationsResponse	The call object.

ListProcessorTypes(ListProcessorTypesRequest, CallOptions)

public virtual ListProcessorTypesResponse ListProcessorTypes(ListProcessorTypesRequest request, CallOptions options)

Lists the processor types that exist.

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

Returns
Type	Description
ListProcessorTypesResponse	The response received from the server.

ListProcessorTypes(ListProcessorTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListProcessorTypesResponse ListProcessorTypes(ListProcessorTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the processor types that exist.

Parameters
Name	Description
request	ListProcessorTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ListProcessorTypesResponse	The response received from the server.

ListProcessorTypesAsync(ListProcessorTypesRequest, CallOptions)

public virtual AsyncUnaryCall<ListProcessorTypesResponse> ListProcessorTypesAsync(ListProcessorTypesRequest request, CallOptions options)

Lists the processor types that exist.

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

Returns
Type	Description
AsyncUnaryCallListProcessorTypesResponse	The call object.

ListProcessorTypesAsync(ListProcessorTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListProcessorTypesResponse> ListProcessorTypesAsync(ListProcessorTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the processor types that exist.

Parameters
Name	Description
request	ListProcessorTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallListProcessorTypesResponse	The call object.

ListProcessorVersions(ListProcessorVersionsRequest, CallOptions)

public virtual ListProcessorVersionsResponse ListProcessorVersions(ListProcessorVersionsRequest request, CallOptions options)

Lists all versions of a processor.

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

Returns
Type	Description
ListProcessorVersionsResponse	The response received from the server.

ListProcessorVersions(ListProcessorVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListProcessorVersionsResponse ListProcessorVersions(ListProcessorVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all versions of a processor.

Parameters
Name	Description
request	ListProcessorVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ListProcessorVersionsResponse	The response received from the server.

ListProcessorVersionsAsync(ListProcessorVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListProcessorVersionsResponse> ListProcessorVersionsAsync(ListProcessorVersionsRequest request, CallOptions options)

Lists all versions of a processor.

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

Returns
Type	Description
AsyncUnaryCallListProcessorVersionsResponse	The call object.

ListProcessorVersionsAsync(ListProcessorVersionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListProcessorVersionsResponse> ListProcessorVersionsAsync(ListProcessorVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all versions of a processor.

Parameters
Name	Description
request	ListProcessorVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallListProcessorVersionsResponse	The call object.

ListProcessors(ListProcessorsRequest, CallOptions)

public virtual ListProcessorsResponse ListProcessors(ListProcessorsRequest request, CallOptions options)

Lists all processors which belong to this project.

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

Returns
Type	Description
ListProcessorsResponse	The response received from the server.

ListProcessors(ListProcessorsRequest, Metadata, DateTime?, CancellationToken)

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

Lists all processors which belong to this project.

Parameters
Name	Description
request	ListProcessorsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
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
Name	Description
request	ListProcessorsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListProcessorsResponse	The call object.

ListProcessorsAsync(ListProcessorsRequest, Metadata, DateTime?, CancellationToken)

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

Lists all processors which belong to this project.

Parameters
Name	Description
request	ListProcessorsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallListProcessorsResponse	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DocumentProcessorServiceDocumentProcessorServiceClient

Overrides

ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

ProcessDocument(ProcessRequest, CallOptions)

public virtual ProcessResponse ProcessDocument(ProcessRequest request, CallOptions options)

Processes a single document.

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

Returns
Type	Description
ProcessResponse	The response received from the server.

ProcessDocument(ProcessRequest, Metadata, DateTime?, CancellationToken)

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

Processes a single document.

Parameters
Name	Description
request	ProcessRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ProcessResponse	The response received from the server.

ProcessDocumentAsync(ProcessRequest, CallOptions)

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

Processes a single document.

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

Returns
Type	Description
AsyncUnaryCallProcessResponse	The call object.

ProcessDocumentAsync(ProcessRequest, Metadata, DateTime?, CancellationToken)

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

Processes a single document.

Parameters
Name	Description
request	ProcessRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallProcessResponse	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
Name	Description
request	ReviewDocumentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ReviewDocument(ReviewDocumentRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ReviewDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ReviewDocumentAsync(ReviewDocumentRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	ReviewDocumentRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, CallOptions)

public virtual Operation SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, CallOptions options)

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

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

Returns
Type	Description
Operation	The response received from the server.

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetDefaultProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

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

Parameters
Name	Description
request	SetDefaultProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

TrainProcessorVersion(TrainProcessorVersionRequest, CallOptions)

public virtual Operation TrainProcessorVersion(TrainProcessorVersionRequest request, CallOptions options)

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

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

Returns
Type	Description
Operation	The response received from the server.

TrainProcessorVersion(TrainProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

Parameters
Name	Description
request	TrainProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

TrainProcessorVersionAsync(TrainProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TrainProcessorVersionAsync(TrainProcessorVersionRequest request, CallOptions options)

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

TrainProcessorVersionAsync(TrainProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Trains a new processor version. Operation metadata is returned as [TrainProcessorVersionMetadata][google.cloud.documentai.v1beta3.TrainProcessorVersionMetadata].

Parameters
Name	Description
request	TrainProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

UndeployProcessorVersion(UndeployProcessorVersionRequest, CallOptions)

public virtual Operation UndeployProcessorVersion(UndeployProcessorVersionRequest request, CallOptions options)

Undeploys the processor version.

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

Returns
Type	Description
Operation	The response received from the server.

UndeployProcessorVersion(UndeployProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Undeploys the processor version.

Parameters
Name	Description
request	UndeployProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UndeployProcessorVersionAsync(UndeployProcessorVersionRequest request, CallOptions options)

Undeploys the processor version.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, Metadata, DateTime?, CancellationToken)

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

Undeploys the processor version.

Parameters
Name	Description
request	UndeployProcessorVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.