public class DocumentProcessorServiceClient : ClientBase<DocumentProcessorService.DocumentProcessorServiceClient>Client for DocumentProcessorService
Inheritance
Object > ClientBase > ClientBase<DocumentProcessorService.DocumentProcessorServiceClient> > DocumentProcessorService.DocumentProcessorServiceClientNamespace
Google.Cloud.DocumentAI.V1Assembly
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 | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
DocumentProcessorServiceClient(ChannelBase)
public DocumentProcessorServiceClient(ChannelBase channel)Creates a new client for DocumentProcessorService
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration)
protected DocumentProcessorServiceClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBase.ClientBaseConfigurationThe 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 |
BatchProcessRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
BatchProcessRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
BatchProcessRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
BatchProcessRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
CreateProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
CreateProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
CreateProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeleteProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeleteProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DeleteProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeleteProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeleteProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeleteProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DeleteProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeleteProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
DeployProcessorVersion(DeployProcessorVersionRequest, CallOptions)
public virtual Operation DeployProcessorVersion(DeployProcessorVersionRequest request, CallOptions options)Deploys the processor version.
| Parameters | |
|---|---|
| Name | Description |
request |
DeployProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeployProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DeployProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DeployProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
DisableProcessor(DisableProcessorRequest, CallOptions)
public virtual Operation DisableProcessor(DisableProcessorRequest request, CallOptions options)Disables a processor
| Parameters | |
|---|---|
| Name | Description |
request |
DisableProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DisableProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
DisableProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
DisableProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
EnableProcessor(EnableProcessorRequest, CallOptions)
public virtual Operation EnableProcessor(EnableProcessorRequest request, CallOptions options)Enables a processor
| Parameters | |
|---|---|
| Name | Description |
request |
EnableProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
EnableProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
EnableProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
EnableProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
FetchProcessorTypesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
FetchProcessorTypesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 do not use ListProcessorTypes here because it is not paginated.
| Parameters | |
|---|---|
| Name | Description |
request |
FetchProcessorTypesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
FetchProcessorTypesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<FetchProcessorTypesResponse> |
The call object. |
GetProcessor(GetProcessorRequest, CallOptions)
public virtual Processor GetProcessor(GetProcessorRequest request, CallOptions options)Gets a processor detail.
| Parameters | |
|---|---|
| Name | Description |
request |
GetProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
GetProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetProcessorRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
GetProcessorRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Processor> |
The call object. |
GetProcessorVersion(GetProcessorVersionRequest, CallOptions)
public virtual ProcessorVersion GetProcessorVersion(GetProcessorVersionRequest request, CallOptions options)Gets a processor version detail.
| Parameters | |
|---|---|
| Name | Description |
request |
GetProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
GetProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
GetProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
GetProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListProcessorsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListProcessorsResponse> |
The call object. |
ListProcessorTypes(ListProcessorTypesRequest, CallOptions)
public virtual ListProcessorTypesResponse ListProcessorTypes(ListProcessorTypesRequest request, CallOptions options)Lists the processor types that exist.
| Parameters | |
|---|---|
| Name | Description |
request |
ListProcessorTypesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorTypesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListProcessorTypesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorTypesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListProcessorTypesResponse> |
The call object. |
ListProcessorVersions(ListProcessorVersionsRequest, CallOptions)
public virtual ListProcessorVersionsResponse ListProcessorVersions(ListProcessorVersionsRequest request, CallOptions options)Lists all versions of a processor.
| Parameters | |
|---|---|
| Name | Description |
request |
ListProcessorVersionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorVersionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ListProcessorVersionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ListProcessorVersionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
configuration |
ClientBase.ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
DocumentProcessorService.DocumentProcessorServiceClient |
|
ProcessDocument(ProcessRequest, CallOptions)
public virtual ProcessResponse ProcessDocument(ProcessRequest request, CallOptions options)Processes a single document.
| Parameters | |
|---|---|
| Name | Description |
request |
ProcessRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ProcessRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ProcessRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ProcessRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ReviewDocumentRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ReviewDocumentRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
ReviewDocumentRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
ReviewDocumentRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
SetDefaultProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
SetDefaultProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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.v1.Processor] that will be used in [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
| Parameters | |
|---|---|
| Name | Description |
request |
SetDefaultProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
SetDefaultProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |
UndeployProcessorVersion(UndeployProcessorVersionRequest, CallOptions)
public virtual Operation UndeployProcessorVersion(UndeployProcessorVersionRequest request, CallOptions options)Undeploys the processor version.
| Parameters | |
|---|---|
| Name | Description |
request |
UndeployProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
UndeployProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn 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 |
UndeployProcessorVersionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
request |
UndeployProcessorVersionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> |
The call object. |