Class DocumentProcessorService.DocumentProcessorServiceClient (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public class DocumentProcessorServiceClient : ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>

Client for DocumentProcessorService

Inheritance

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

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

DocumentProcessorServiceClient()

protected DocumentProcessorServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DocumentProcessorServiceClient(CallInvoker)

public DocumentProcessorServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DocumentProcessorServiceClient(ChannelBase)

public DocumentProcessorServiceClient(ChannelBase channel)

Creates a new client for DocumentProcessorService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration)

protected DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

BatchProcessDocuments(BatchProcessRequest, CallOptions)

public virtual Operation BatchProcessDocuments(BatchProcessRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

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

Parameters
NameDescription
requestBatchProcessRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchProcessDocumentsAsync(BatchProcessRequest, CallOptions)

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

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

Parameters
NameDescription
requestBatchProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

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

Parameters
NameDescription
requestBatchProcessRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

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

Returns
TypeDescription
Locations.LocationsClient

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
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

CreateProcessor(CreateProcessorRequest, CallOptions)

public virtual Processor CreateProcessor(CreateProcessorRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Processor

The response received from the server.

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

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

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

Parameters
NameDescription
requestCreateProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Processor

The response received from the server.

CreateProcessorAsync(CreateProcessorRequest, CallOptions)

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

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

Parameters
NameDescription
requestCreateProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Processor>

The call object.

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

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

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

Parameters
NameDescription
requestCreateProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Processor>

The call object.

DeleteProcessor(DeleteProcessorRequest, CallOptions)

public virtual Operation DeleteProcessor(DeleteProcessorRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

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

Parameters
NameDescription
requestDeleteProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteProcessorAsync(DeleteProcessorRequest, CallOptions)

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

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

Parameters
NameDescription
requestDeleteProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

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

Parameters
NameDescription
requestDeleteProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteProcessorVersion(DeleteProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestDeleteProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestDeleteProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeployProcessorVersion(DeployProcessorVersionRequest, CallOptions)

public virtual Operation DeployProcessorVersion(DeployProcessorVersionRequest request, CallOptions options)

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeployProcessorVersion(DeployProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallOptions)

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

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeployProcessorVersionAsync(DeployProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DisableProcessor(DisableProcessorRequest, CallOptions)

public virtual Operation DisableProcessor(DisableProcessorRequest request, CallOptions options)

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DisableProcessorAsync(DisableProcessorRequest, CallOptions)

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

EnableProcessor(EnableProcessorRequest, CallOptions)

public virtual Operation EnableProcessor(EnableProcessorRequest request, CallOptions options)

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

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

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

EnableProcessorAsync(EnableProcessorRequest, CallOptions)

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

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

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

FetchProcessorTypes(FetchProcessorTypesRequest, CallOptions)

public virtual FetchProcessorTypesResponse FetchProcessorTypes(FetchProcessorTypesRequest request, CallOptions options)

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FetchProcessorTypesResponse

The response received from the server.

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

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

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
FetchProcessorTypesResponse

The response received from the server.

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallOptions)

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

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<FetchProcessorTypesResponse>

The call object.

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

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

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<FetchProcessorTypesResponse>

The call object.

GetProcessor(GetProcessorRequest, CallOptions)

public virtual Processor GetProcessor(GetProcessorRequest request, CallOptions options)

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Processor

The response received from the server.

GetProcessor(GetProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Processor

The response received from the server.

GetProcessorAsync(GetProcessorRequest, CallOptions)

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

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Processor>

The call object.

GetProcessorAsync(GetProcessorRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Processor>

The call object.

GetProcessorVersion(GetProcessorVersionRequest, CallOptions)

public virtual ProcessorVersion GetProcessorVersion(GetProcessorVersionRequest request, CallOptions options)

Gets a processor version detail.

Parameters
NameDescription
requestGetProcessorVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ProcessorVersion

The response received from the server.

GetProcessorVersion(GetProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a processor version detail.

Parameters
NameDescription
requestGetProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ProcessorVersion>

The call object.

GetProcessorVersionAsync(GetProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Gets a processor version detail.

Parameters
NameDescription
requestGetProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ProcessorVersion>

The call object.

ListProcessors(ListProcessorsRequest, CallOptions)

public virtual ListProcessorsResponse ListProcessors(ListProcessorsRequest request, CallOptions options)

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListProcessorsResponse

The response received from the server.

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

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

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListProcessorsResponse

The response received from the server.

ListProcessorsAsync(ListProcessorsRequest, CallOptions)

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

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorsResponse>

The call object.

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

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

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorsResponse>

The call object.

ListProcessorTypes(ListProcessorTypesRequest, CallOptions)

public virtual ListProcessorTypesResponse ListProcessorTypes(ListProcessorTypesRequest request, CallOptions options)

Lists the processor types that exist.

Parameters
NameDescription
requestListProcessorTypesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListProcessorTypesResponse

The response received from the server.

ListProcessorTypes(ListProcessorTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists the processor types that exist.

Parameters
NameDescription
requestListProcessorTypesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorTypesResponse>

The call object.

ListProcessorTypesAsync(ListProcessorTypesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists the processor types that exist.

Parameters
NameDescription
requestListProcessorTypesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorTypesResponse>

The call object.

ListProcessorVersions(ListProcessorVersionsRequest, CallOptions)

public virtual ListProcessorVersionsResponse ListProcessorVersions(ListProcessorVersionsRequest request, CallOptions options)

Lists all versions of a processor.

Parameters
NameDescription
requestListProcessorVersionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListProcessorVersionsResponse

The response received from the server.

ListProcessorVersions(ListProcessorVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists all versions of a processor.

Parameters
NameDescription
requestListProcessorVersionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorVersionsResponse>

The call object.

ListProcessorVersionsAsync(ListProcessorVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists all versions of a processor.

Parameters
NameDescription
requestListProcessorVersionsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListProcessorVersionsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

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

ProcessDocument(ProcessRequest, CallOptions)

public virtual ProcessResponse ProcessDocument(ProcessRequest request, CallOptions options)

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ProcessResponse

The response received from the server.

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

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

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ProcessResponse

The response received from the server.

ProcessDocumentAsync(ProcessRequest, CallOptions)

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

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ProcessResponse>

The call object.

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

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

Processes a single document.

Parameters
NameDescription
requestProcessRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ProcessResponse>

The call object.

ReviewDocument(ReviewDocumentRequest, CallOptions)

public virtual Operation ReviewDocument(ReviewDocumentRequest request, CallOptions options)

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

Parameters
NameDescription
requestReviewDocumentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ReviewDocument(ReviewDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestReviewDocumentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ReviewDocumentAsync(ReviewDocumentRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ReviewDocumentAsync(ReviewDocumentRequest request, CallOptions options)

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

Parameters
NameDescription
requestReviewDocumentRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ReviewDocumentAsync(ReviewDocumentRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

Parameters
NameDescription
requestReviewDocumentRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, CallOptions)

public virtual Operation SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest request, CallOptions options)

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, CallOptions)

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

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

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

SetDefaultProcessorVersionAsync(SetDefaultProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UndeployProcessorVersion(UndeployProcessorVersionRequest, CallOptions)

public virtual Operation UndeployProcessorVersion(UndeployProcessorVersionRequest request, CallOptions options)

Undeploys the processor version.

Parameters
NameDescription
requestUndeployProcessorVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UndeployProcessorVersion(UndeployProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Undeploys the processor version.

Parameters
NameDescription
requestUndeployProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, CallOptions)

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

Undeploys the processor version.

Parameters
NameDescription
requestUndeployProcessorVersionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UndeployProcessorVersionAsync(UndeployProcessorVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Undeploys the processor version.

Parameters
NameDescription
requestUndeployProcessorVersionRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.