Cloud Document AI v1 API - Class DocumentProcessorServiceClient (3.7.0)

public abstract class DocumentProcessorServiceClient

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

DocumentProcessorService client wrapper, for convenient use.

Inheritance

object > DocumentProcessorServiceClient

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Remarks

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

Properties

BatchProcessDocumentsOperationsClient

public virtual OperationsClient BatchProcessDocumentsOperationsClient { get; }

The long-running operations client for BatchProcessDocuments.

Property Value
TypeDescription
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the DocumentProcessorService service, which is a host of "documentai.googleapis.com" and a port of 443.

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DocumentProcessorService scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

The default DocumentProcessorService scopes are:

DeleteProcessorOperationsClient

public virtual OperationsClient DeleteProcessorOperationsClient { get; }

The long-running operations client for DeleteProcessor.

Property Value
TypeDescription
OperationsClient

DeleteProcessorVersionOperationsClient

public virtual OperationsClient DeleteProcessorVersionOperationsClient { get; }

The long-running operations client for DeleteProcessorVersion.

Property Value
TypeDescription
OperationsClient

DeployProcessorVersionOperationsClient

public virtual OperationsClient DeployProcessorVersionOperationsClient { get; }

The long-running operations client for DeployProcessorVersion.

Property Value
TypeDescription
OperationsClient

DisableProcessorOperationsClient

public virtual OperationsClient DisableProcessorOperationsClient { get; }

The long-running operations client for DisableProcessor.

Property Value
TypeDescription
OperationsClient

EnableProcessorOperationsClient

public virtual OperationsClient EnableProcessorOperationsClient { get; }

The long-running operations client for EnableProcessor.

Property Value
TypeDescription
OperationsClient

EvaluateProcessorVersionOperationsClient

public virtual OperationsClient EvaluateProcessorVersionOperationsClient { get; }

The long-running operations client for EvaluateProcessorVersion.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual DocumentProcessorService.DocumentProcessorServiceClient GrpcClient { get; }

The underlying gRPC DocumentProcessorService client

Property Value
TypeDescription
DocumentProcessorServiceDocumentProcessorServiceClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient

ReviewDocumentOperationsClient

public virtual OperationsClient ReviewDocumentOperationsClient { get; }

The long-running operations client for ReviewDocument.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

SetDefaultProcessorVersionOperationsClient

public virtual OperationsClient SetDefaultProcessorVersionOperationsClient { get; }

The long-running operations client for SetDefaultProcessorVersion.

Property Value
TypeDescription
OperationsClient

TrainProcessorVersionOperationsClient

public virtual OperationsClient TrainProcessorVersionOperationsClient { get; }

The long-running operations client for TrainProcessorVersion.

Property Value
TypeDescription
OperationsClient

UndeployProcessorVersionOperationsClient

public virtual OperationsClient UndeployProcessorVersionOperationsClient { get; }

The long-running operations client for UndeployProcessorVersion.

Property Value
TypeDescription
OperationsClient

Methods

BatchProcessDocuments(IResourceName, CallSettings)

public virtual Operation<BatchProcessResponse, BatchProcessMetadata> BatchProcessDocuments(IResourceName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameIResourceName

Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBatchProcessResponseBatchProcessMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = documentProcessorServiceClient.BatchProcessDocuments(name);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceBatchProcessDocuments(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocuments(BatchProcessRequest, CallSettings)

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

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

Parameters
NameDescription
requestBatchProcessRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBatchProcessResponseBatchProcessMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
BatchProcessRequest request = new BatchProcessRequest
{
    ResourceName = new UnparsedResourceName("a/wildcard/resource"),
    SkipHumanReview = false,
    InputDocuments = new BatchDocumentsInputConfig(),
    DocumentOutputConfig = new DocumentOutputConfig(),
};
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = documentProcessorServiceClient.BatchProcessDocuments(request);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceBatchProcessDocuments(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocuments(string, CallSettings)

public virtual Operation<BatchProcessResponse, BatchProcessMetadata> BatchProcessDocuments(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBatchProcessResponseBatchProcessMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "a/wildcard/resource";
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = documentProcessorServiceClient.BatchProcessDocuments(name);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceBatchProcessDocuments(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocumentsAsync(IResourceName, CallSettings)

public virtual Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(IResourceName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameIResourceName

Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = await documentProcessorServiceClient.BatchProcessDocumentsAsync(name);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocumentsAsync(IResourceName, CancellationToken)

public virtual Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(IResourceName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameIResourceName

Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = await documentProcessorServiceClient.BatchProcessDocumentsAsync(name);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocumentsAsync(BatchProcessRequest, CallSettings)

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

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

Parameters
NameDescription
requestBatchProcessRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
BatchProcessRequest request = new BatchProcessRequest
{
    ResourceName = new UnparsedResourceName("a/wildcard/resource"),
    SkipHumanReview = false,
    InputDocuments = new BatchDocumentsInputConfig(),
    DocumentOutputConfig = new DocumentOutputConfig(),
};
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = await documentProcessorServiceClient.BatchProcessDocumentsAsync(request);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocumentsAsync(BatchProcessRequest, CancellationToken)

public virtual Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(BatchProcessRequest request, CancellationToken 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 object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
BatchProcessRequest request = new BatchProcessRequest
{
    ResourceName = new UnparsedResourceName("a/wildcard/resource"),
    SkipHumanReview = false,
    InputDocuments = new BatchDocumentsInputConfig(),
    DocumentOutputConfig = new DocumentOutputConfig(),
};
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = await documentProcessorServiceClient.BatchProcessDocumentsAsync(request);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocumentsAsync(string, CallSettings)

public virtual Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "a/wildcard/resource";
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = await documentProcessorServiceClient.BatchProcessDocumentsAsync(name);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

BatchProcessDocumentsAsync(string, CancellationToken)

public virtual Task<Operation<BatchProcessResponse, BatchProcessMetadata>> BatchProcessDocumentsAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
namestring

Required. The resource name of [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "a/wildcard/resource";
// Make the request
Operation<BatchProcessResponse, BatchProcessMetadata> response = await documentProcessorServiceClient.BatchProcessDocumentsAsync(name);

// Poll until the returned long-running operation is complete
Operation<BatchProcessResponse, BatchProcessMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchProcessResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchProcessResponse, BatchProcessMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceBatchProcessDocumentsAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchProcessResponse retrievedResult = retrievedResponse.Result;
}

Create()

public static DocumentProcessorServiceClient Create()

Synchronously creates a DocumentProcessorServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DocumentProcessorServiceClientBuilder.

Returns
TypeDescription
DocumentProcessorServiceClient

The created DocumentProcessorServiceClient.

CreateAsync(CancellationToken)

public static Task<DocumentProcessorServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a DocumentProcessorServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DocumentProcessorServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskDocumentProcessorServiceClient

The task representing the created DocumentProcessorServiceClient.

CreateProcessor(LocationName, Processor, CallSettings)

public virtual Processor CreateProcessor(LocationName parent, Processor processor, CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Processor processor = new Processor();
// Make the request
Processor response = documentProcessorServiceClient.CreateProcessor(parent, processor);

CreateProcessor(CreateProcessorRequest, CallSettings)

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

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

Parameters
NameDescription
requestCreateProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
CreateProcessorRequest request = new CreateProcessorRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Processor = new Processor(),
};
// Make the request
Processor response = documentProcessorServiceClient.CreateProcessor(request);

CreateProcessor(string, Processor, CallSettings)

public virtual Processor CreateProcessor(string parent, Processor processor, CallSettings callSettings = null)

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

Parameters
NameDescription
parentstring

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Processor processor = new Processor();
// Make the request
Processor response = documentProcessorServiceClient.CreateProcessor(parent, processor);

CreateProcessorAsync(LocationName, Processor, CallSettings)

public virtual Task<Processor> CreateProcessorAsync(LocationName parent, Processor processor, CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Processor processor = new Processor();
// Make the request
Processor response = await documentProcessorServiceClient.CreateProcessorAsync(parent, processor);

CreateProcessorAsync(LocationName, Processor, CancellationToken)

public virtual Task<Processor> CreateProcessorAsync(LocationName parent, Processor processor, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentLocationName

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Processor processor = new Processor();
// Make the request
Processor response = await documentProcessorServiceClient.CreateProcessorAsync(parent, processor);

CreateProcessorAsync(CreateProcessorRequest, CallSettings)

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

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

Parameters
NameDescription
requestCreateProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
CreateProcessorRequest request = new CreateProcessorRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Processor = new Processor(),
};
// Make the request
Processor response = await documentProcessorServiceClient.CreateProcessorAsync(request);

CreateProcessorAsync(CreateProcessorRequest, CancellationToken)

public virtual Task<Processor> CreateProcessorAsync(CreateProcessorRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestCreateProcessorRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
CreateProcessorRequest request = new CreateProcessorRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Processor = new Processor(),
};
// Make the request
Processor response = await documentProcessorServiceClient.CreateProcessorAsync(request);

CreateProcessorAsync(string, Processor, CallSettings)

public virtual Task<Processor> CreateProcessorAsync(string parent, Processor processor, CallSettings callSettings = null)

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

Parameters
NameDescription
parentstring

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Processor processor = new Processor();
// Make the request
Processor response = await documentProcessorServiceClient.CreateProcessorAsync(parent, processor);

CreateProcessorAsync(string, Processor, CancellationToken)

public virtual Task<Processor> CreateProcessorAsync(string parent, Processor processor, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentstring

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

processorProcessor

Required. The processor to be created, requires [Processor.type][google.cloud.documentai.v1.Processor.type] and [Processor.display_name]][] to be set. Also, the [Processor.kms_key_name][google.cloud.documentai.v1.Processor.kms_key_name] field must be set if the processor is under CMEK.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Processor processor = new Processor();
// Make the request
Processor response = await documentProcessorServiceClient.CreateProcessorAsync(parent, processor);

DeleteProcessor(DeleteProcessorRequest, CallSettings)

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

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

Parameters
NameDescription
requestDeleteProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
DeleteProcessorRequest request = new DeleteProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = documentProcessorServiceClient.DeleteProcessor(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessor(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessor(ProcessorName, CallSettings)

public virtual Operation<Empty, DeleteProcessorMetadata> DeleteProcessor(ProcessorName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameProcessorName

Required. The processor resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorName name = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = documentProcessorServiceClient.DeleteProcessor(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessor(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessor(string, CallSettings)

public virtual Operation<Empty, DeleteProcessorMetadata> DeleteProcessor(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. The processor resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = documentProcessorServiceClient.DeleteProcessor(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessor(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorAsync(DeleteProcessorRequest, CallSettings)

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

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

Parameters
NameDescription
requestDeleteProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteProcessorRequest request = new DeleteProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = await documentProcessorServiceClient.DeleteProcessorAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorAsync(DeleteProcessorRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(DeleteProcessorRequest request, CancellationToken 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 object containing all of the parameters for the API call.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteProcessorRequest request = new DeleteProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = await documentProcessorServiceClient.DeleteProcessorAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorAsync(ProcessorName, CallSettings)

public virtual Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(ProcessorName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameProcessorName

Required. The processor resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorName name = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = await documentProcessorServiceClient.DeleteProcessorAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorAsync(ProcessorName, CancellationToken)

public virtual Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(ProcessorName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameProcessorName

Required. The processor resource name to be deleted.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorName name = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = await documentProcessorServiceClient.DeleteProcessorAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. The processor resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = await documentProcessorServiceClient.DeleteProcessorAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteProcessorMetadata>> DeleteProcessorAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
namestring

Required. The processor resource name to be deleted.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
Operation<Empty, DeleteProcessorMetadata> response = await documentProcessorServiceClient.DeleteProcessorAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersion(DeleteProcessorVersionRequest, CallSettings)

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

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

Parameters
NameDescription
requestDeleteProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
DeleteProcessorVersionRequest request = new DeleteProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = documentProcessorServiceClient.DeleteProcessorVersion(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersion(ProcessorVersionName, CallSettings)

public virtual Operation<Empty, DeleteProcessorVersionMetadata> DeleteProcessorVersion(ProcessorVersionName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = documentProcessorServiceClient.DeleteProcessorVersion(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersion(string, CallSettings)

public virtual Operation<Empty, DeleteProcessorVersionMetadata> DeleteProcessorVersion(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. The processor version resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = documentProcessorServiceClient.DeleteProcessorVersion(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeleteProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CallSettings)

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

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

Parameters
NameDescription
requestDeleteProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteProcessorVersionRequest request = new DeleteProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = await documentProcessorServiceClient.DeleteProcessorVersionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersionAsync(DeleteProcessorVersionRequest, CancellationToken)

public virtual Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(DeleteProcessorVersionRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestDeleteProcessorVersionRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteProcessorVersionRequest request = new DeleteProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = await documentProcessorServiceClient.DeleteProcessorVersionAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersionAsync(ProcessorVersionName, CallSettings)

public virtual Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(ProcessorVersionName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = await documentProcessorServiceClient.DeleteProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersionAsync(ProcessorVersionName, CancellationToken)

public virtual Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(ProcessorVersionName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deleted.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = await documentProcessorServiceClient.DeleteProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
namestring

Required. The processor version resource name to be deleted.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = await documentProcessorServiceClient.DeleteProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteProcessorVersionAsync(string, CancellationToken)

public virtual Task<Operation<Empty, DeleteProcessorVersionMetadata>> DeleteProcessorVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
namestring

Required. The processor version resource name to be deleted.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<Empty, DeleteProcessorVersionMetadata> response = await documentProcessorServiceClient.DeleteProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, DeleteProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, DeleteProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeleteProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersion(DeployProcessorVersionRequest, CallSettings)

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

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
DeployProcessorVersionRequest request = new DeployProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = documentProcessorServiceClient.DeployProcessorVersion(request);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeployProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersion(ProcessorVersionName, CallSettings)

public virtual Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> DeployProcessorVersion(ProcessorVersionName name, CallSettings callSettings = null)

Deploys the processor version.

Parameters
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deployed.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = documentProcessorServiceClient.DeployProcessorVersion(name);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeployProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersion(string, CallSettings)

public virtual Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> DeployProcessorVersion(string name, CallSettings callSettings = null)

Deploys the processor version.

Parameters
NameDescription
namestring

Required. The processor version resource name to be deployed.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = documentProcessorServiceClient.DeployProcessorVersion(name);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDeployProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersionAsync(DeployProcessorVersionRequest, CallSettings)

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

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DeployProcessorVersionRequest request = new DeployProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = await documentProcessorServiceClient.DeployProcessorVersionAsync(request);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersionAsync(DeployProcessorVersionRequest, CancellationToken)

public virtual Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(DeployProcessorVersionRequest request, CancellationToken cancellationToken)

Deploys the processor version.

Parameters
NameDescription
requestDeployProcessorVersionRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DeployProcessorVersionRequest request = new DeployProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = await documentProcessorServiceClient.DeployProcessorVersionAsync(request);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersionAsync(ProcessorVersionName, CallSettings)

public virtual Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(ProcessorVersionName name, CallSettings callSettings = null)

Deploys the processor version.

Parameters
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deployed.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = await documentProcessorServiceClient.DeployProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersionAsync(ProcessorVersionName, CancellationToken)

public virtual Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(ProcessorVersionName name, CancellationToken cancellationToken)

Deploys the processor version.

Parameters
NameDescription
nameProcessorVersionName

Required. The processor version resource name to be deployed.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = await documentProcessorServiceClient.DeployProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(string name, CallSettings callSettings = null)

Deploys the processor version.

Parameters
NameDescription
namestring

Required. The processor version resource name to be deployed.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = await documentProcessorServiceClient.DeployProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DeployProcessorVersionAsync(string, CancellationToken)

public virtual Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> DeployProcessorVersionAsync(string name, CancellationToken cancellationToken)

Deploys the processor version.

Parameters
NameDescription
namestring

Required. The processor version resource name to be deployed.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> response = await documentProcessorServiceClient.DeployProcessorVersionAsync(name);

// Poll until the returned long-running operation is complete
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DeployProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDeployProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DeployProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

DisableProcessor(DisableProcessorRequest, CallSettings)

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDisableProcessorResponseDisableProcessorMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
DisableProcessorRequest request = new DisableProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<DisableProcessorResponse, DisableProcessorMetadata> response = documentProcessorServiceClient.DisableProcessor(request);

// Poll until the returned long-running operation is complete
Operation<DisableProcessorResponse, DisableProcessorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
DisableProcessorResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DisableProcessorResponse, DisableProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceDisableProcessor(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DisableProcessorResponse retrievedResult = retrievedResponse.Result;
}

DisableProcessorAsync(DisableProcessorRequest, CallSettings)

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

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDisableProcessorResponseDisableProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DisableProcessorRequest request = new DisableProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<DisableProcessorResponse, DisableProcessorMetadata> response = await documentProcessorServiceClient.DisableProcessorAsync(request);

// Poll until the returned long-running operation is complete
Operation<DisableProcessorResponse, DisableProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DisableProcessorResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DisableProcessorResponse, DisableProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDisableProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DisableProcessorResponse retrievedResult = retrievedResponse.Result;
}

DisableProcessorAsync(DisableProcessorRequest, CancellationToken)

public virtual Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>> DisableProcessorAsync(DisableProcessorRequest request, CancellationToken cancellationToken)

Disables a processor

Parameters
NameDescription
requestDisableProcessorRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationDisableProcessorResponseDisableProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
DisableProcessorRequest request = new DisableProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<DisableProcessorResponse, DisableProcessorMetadata> response = await documentProcessorServiceClient.DisableProcessorAsync(request);

// Poll until the returned long-running operation is complete
Operation<DisableProcessorResponse, DisableProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
DisableProcessorResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<DisableProcessorResponse, DisableProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceDisableProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    DisableProcessorResponse retrievedResult = retrievedResponse.Result;
}

EnableProcessor(EnableProcessorRequest, CallSettings)

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEnableProcessorResponseEnableProcessorMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
EnableProcessorRequest request = new EnableProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<EnableProcessorResponse, EnableProcessorMetadata> response = documentProcessorServiceClient.EnableProcessor(request);

// Poll until the returned long-running operation is complete
Operation<EnableProcessorResponse, EnableProcessorMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
EnableProcessorResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EnableProcessorResponse, EnableProcessorMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceEnableProcessor(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EnableProcessorResponse retrievedResult = retrievedResponse.Result;
}

EnableProcessorAsync(EnableProcessorRequest, CallSettings)

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

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEnableProcessorResponseEnableProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
EnableProcessorRequest request = new EnableProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<EnableProcessorResponse, EnableProcessorMetadata> response = await documentProcessorServiceClient.EnableProcessorAsync(request);

// Poll until the returned long-running operation is complete
Operation<EnableProcessorResponse, EnableProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EnableProcessorResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EnableProcessorResponse, EnableProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEnableProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EnableProcessorResponse retrievedResult = retrievedResponse.Result;
}

EnableProcessorAsync(EnableProcessorRequest, CancellationToken)

public virtual Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>> EnableProcessorAsync(EnableProcessorRequest request, CancellationToken cancellationToken)

Enables a processor

Parameters
NameDescription
requestEnableProcessorRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEnableProcessorResponseEnableProcessorMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
EnableProcessorRequest request = new EnableProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Operation<EnableProcessorResponse, EnableProcessorMetadata> response = await documentProcessorServiceClient.EnableProcessorAsync(request);

// Poll until the returned long-running operation is complete
Operation<EnableProcessorResponse, EnableProcessorMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EnableProcessorResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EnableProcessorResponse, EnableProcessorMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEnableProcessorAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EnableProcessorResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersion(EvaluateProcessorVersionRequest, CallSettings)

public virtual Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> EvaluateProcessorVersion(EvaluateProcessorVersionRequest request, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
requestEvaluateProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
EvaluateProcessorVersionRequest request = new EvaluateProcessorVersionRequest
{
    ProcessorVersionAsProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
    EvaluationDocuments = new BatchDocumentsInputConfig(),
};
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = documentProcessorServiceClient.EvaluateProcessorVersion(request);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceEvaluateProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersion(ProcessorVersionName, CallSettings)

public virtual Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> EvaluateProcessorVersion(ProcessorVersionName processorVersion, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
processorVersionProcessorVersionName

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorVersionName processorVersion = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = documentProcessorServiceClient.EvaluateProcessorVersion(processorVersion);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceEvaluateProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersion(string, CallSettings)

public virtual Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> EvaluateProcessorVersion(string processorVersion, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
processorVersionstring

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string processorVersion = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = documentProcessorServiceClient.EvaluateProcessorVersion(processorVersion);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceEvaluateProcessorVersion(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest, CallSettings)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest request, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
requestEvaluateProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluateProcessorVersionRequest request = new EvaluateProcessorVersionRequest
{
    ProcessorVersionAsProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
    EvaluationDocuments = new BatchDocumentsInputConfig(),
};
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = await documentProcessorServiceClient.EvaluateProcessorVersionAsync(request);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEvaluateProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest, CancellationToken)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(EvaluateProcessorVersionRequest request, CancellationToken cancellationToken)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
requestEvaluateProcessorVersionRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluateProcessorVersionRequest request = new EvaluateProcessorVersionRequest
{
    ProcessorVersionAsProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
    EvaluationDocuments = new BatchDocumentsInputConfig(),
};
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = await documentProcessorServiceClient.EvaluateProcessorVersionAsync(request);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEvaluateProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersionAsync(ProcessorVersionName, CallSettings)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(ProcessorVersionName processorVersion, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
processorVersionProcessorVersionName

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName processorVersion = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = await documentProcessorServiceClient.EvaluateProcessorVersionAsync(processorVersion);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEvaluateProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersionAsync(ProcessorVersionName, CancellationToken)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(ProcessorVersionName processorVersion, CancellationToken cancellationToken)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
processorVersionProcessorVersionName

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName processorVersion = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = await documentProcessorServiceClient.EvaluateProcessorVersionAsync(processorVersion);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEvaluateProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(string processorVersion, CallSettings callSettings = null)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
processorVersionstring

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string processorVersion = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = await documentProcessorServiceClient.EvaluateProcessorVersionAsync(processorVersion);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEvaluateProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

EvaluateProcessorVersionAsync(string, CancellationToken)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> EvaluateProcessorVersionAsync(string processorVersion, CancellationToken cancellationToken)

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters
NameDescription
processorVersionstring

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string processorVersion = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> response = await documentProcessorServiceClient.EvaluateProcessorVersionAsync(processorVersion);

// Poll until the returned long-running operation is complete
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
EvaluateProcessorVersionResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceEvaluateProcessorVersionAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    EvaluateProcessorVersionResponse retrievedResult = retrievedResponse.Result;
}

FetchProcessorTypes(LocationName, CallSettings)

public virtual FetchProcessorTypesResponse FetchProcessorTypes(LocationName parent, CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FetchProcessorTypesResponse

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
FetchProcessorTypesResponse response = documentProcessorServiceClient.FetchProcessorTypes(parent);

FetchProcessorTypes(FetchProcessorTypesRequest, CallSettings)

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

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FetchProcessorTypesResponse

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
FetchProcessorTypesRequest request = new FetchProcessorTypesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
FetchProcessorTypesResponse response = documentProcessorServiceClient.FetchProcessorTypes(request);

FetchProcessorTypes(string, CallSettings)

public virtual FetchProcessorTypesResponse FetchProcessorTypes(string parent, CallSettings callSettings = null)

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

Parameters
NameDescription
parentstring

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FetchProcessorTypesResponse

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
FetchProcessorTypesResponse response = documentProcessorServiceClient.FetchProcessorTypes(parent);

FetchProcessorTypesAsync(LocationName, CallSettings)

public virtual Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(LocationName parent, CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskFetchProcessorTypesResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
FetchProcessorTypesResponse response = await documentProcessorServiceClient.FetchProcessorTypesAsync(parent);

FetchProcessorTypesAsync(LocationName, CancellationToken)

public virtual Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(LocationName parent, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentLocationName

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskFetchProcessorTypesResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
FetchProcessorTypesResponse response = await documentProcessorServiceClient.FetchProcessorTypesAsync(parent);

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CallSettings)

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

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskFetchProcessorTypesResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
FetchProcessorTypesRequest request = new FetchProcessorTypesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
FetchProcessorTypesResponse response = await documentProcessorServiceClient.FetchProcessorTypesAsync(request);

FetchProcessorTypesAsync(FetchProcessorTypesRequest, CancellationToken)

public virtual Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(FetchProcessorTypesRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestFetchProcessorTypesRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskFetchProcessorTypesResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
FetchProcessorTypesRequest request = new FetchProcessorTypesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
FetchProcessorTypesResponse response = await documentProcessorServiceClient.FetchProcessorTypesAsync(request);

FetchProcessorTypesAsync(string, CallSettings)

public virtual Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(string parent, CallSettings callSettings = null)

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

Parameters
NameDescription
parentstring

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskFetchProcessorTypesResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
FetchProcessorTypesResponse response = await documentProcessorServiceClient.FetchProcessorTypesAsync(parent);

FetchProcessorTypesAsync(string, CancellationToken)

public virtual Task<FetchProcessorTypesResponse> FetchProcessorTypesAsync(string parent, CancellationToken cancellationToken)

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

Parameters
NameDescription
parentstring

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskFetchProcessorTypesResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
FetchProcessorTypesResponse response = await documentProcessorServiceClient.FetchProcessorTypesAsync(parent);

GetEvaluation(EvaluationName, CallSettings)

public virtual Evaluation GetEvaluation(EvaluationName name, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
NameDescription
nameEvaluationName

Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Evaluation

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
EvaluationName name = EvaluationName.FromProjectLocationProcessorProcessorVersionEvaluation("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]");
// Make the request
Evaluation response = documentProcessorServiceClient.GetEvaluation(name);

GetEvaluation(GetEvaluationRequest, CallSettings)

public virtual Evaluation GetEvaluation(GetEvaluationRequest request, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
NameDescription
requestGetEvaluationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Evaluation

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
GetEvaluationRequest request = new GetEvaluationRequest
{
    EvaluationName = EvaluationName.FromProjectLocationProcessorProcessorVersionEvaluation("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]"),
};
// Make the request
Evaluation response = documentProcessorServiceClient.GetEvaluation(request);

GetEvaluation(string, CallSettings)

public virtual Evaluation GetEvaluation(string name, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
NameDescription
namestring

Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Evaluation

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]/evaluations/[EVALUATION]";
// Make the request
Evaluation response = documentProcessorServiceClient.GetEvaluation(name);

GetEvaluationAsync(EvaluationName, CallSettings)

public virtual Task<Evaluation> GetEvaluationAsync(EvaluationName name, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
NameDescription
nameEvaluationName

Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEvaluation

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationName name = EvaluationName.FromProjectLocationProcessorProcessorVersionEvaluation("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]");
// Make the request
Evaluation response = await documentProcessorServiceClient.GetEvaluationAsync(name);

GetEvaluationAsync(EvaluationName, CancellationToken)

public virtual Task<Evaluation> GetEvaluationAsync(EvaluationName name, CancellationToken cancellationToken)

Retrieves a specific evaluation.

Parameters
NameDescription
nameEvaluationName

Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskEvaluation

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
EvaluationName name = EvaluationName.FromProjectLocationProcessorProcessorVersionEvaluation("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]");
// Make the request
Evaluation response = await documentProcessorServiceClient.GetEvaluationAsync(name);

GetEvaluationAsync(GetEvaluationRequest, CallSettings)

public virtual Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
NameDescription
requestGetEvaluationRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEvaluation

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetEvaluationRequest request = new GetEvaluationRequest
{
    EvaluationName = EvaluationName.FromProjectLocationProcessorProcessorVersionEvaluation("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]"),
};
// Make the request
Evaluation response = await documentProcessorServiceClient.GetEvaluationAsync(request);

GetEvaluationAsync(GetEvaluationRequest, CancellationToken)

public virtual Task<Evaluation> GetEvaluationAsync(GetEvaluationRequest request, CancellationToken cancellationToken)

Retrieves a specific evaluation.

Parameters
NameDescription
requestGetEvaluationRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskEvaluation

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetEvaluationRequest request = new GetEvaluationRequest
{
    EvaluationName = EvaluationName.FromProjectLocationProcessorProcessorVersionEvaluation("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]", "[EVALUATION]"),
};
// Make the request
Evaluation response = await documentProcessorServiceClient.GetEvaluationAsync(request);

GetEvaluationAsync(string, CallSettings)

public virtual Task<Evaluation> GetEvaluationAsync(string name, CallSettings callSettings = null)

Retrieves a specific evaluation.

Parameters
NameDescription
namestring

Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskEvaluation

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]/evaluations/[EVALUATION]";
// Make the request
Evaluation response = await documentProcessorServiceClient.GetEvaluationAsync(name);

GetEvaluationAsync(string, CancellationToken)

public virtual Task<Evaluation> GetEvaluationAsync(string name, CancellationToken cancellationToken)

Retrieves a specific evaluation.

Parameters
NameDescription
namestring

Required. The resource name of the [Evaluation][google.cloud.documentai.v1.Evaluation] to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskEvaluation

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]/evaluations/[EVALUATION]";
// Make the request
Evaluation response = await documentProcessorServiceClient.GetEvaluationAsync(name);

GetProcessor(GetProcessorRequest, CallSettings)

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

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
GetProcessorRequest request = new GetProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Processor response = documentProcessorServiceClient.GetProcessor(request);

GetProcessor(ProcessorName, CallSettings)

public virtual Processor GetProcessor(ProcessorName name, CallSettings callSettings = null)

Gets a processor detail.

Parameters
NameDescription
nameProcessorName

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorName name = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Processor response = documentProcessorServiceClient.GetProcessor(name);

GetProcessor(string, CallSettings)

public virtual Processor GetProcessor(string name, CallSettings callSettings = null)

Gets a processor detail.

Parameters
NameDescription
namestring

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Processor

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
Processor response = documentProcessorServiceClient.GetProcessor(name);

GetProcessorAsync(GetProcessorRequest, CallSettings)

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

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetProcessorRequest request = new GetProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Processor response = await documentProcessorServiceClient.GetProcessorAsync(request);

GetProcessorAsync(GetProcessorRequest, CancellationToken)

public virtual Task<Processor> GetProcessorAsync(GetProcessorRequest request, CancellationToken cancellationToken)

Gets a processor detail.

Parameters
NameDescription
requestGetProcessorRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetProcessorRequest request = new GetProcessorRequest
{
    ProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
Processor response = await documentProcessorServiceClient.GetProcessorAsync(request);

GetProcessorAsync(ProcessorName, CallSettings)

public virtual Task<Processor> GetProcessorAsync(ProcessorName name, CallSettings callSettings = null)

Gets a processor detail.

Parameters
NameDescription
nameProcessorName

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorName name = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Processor response = await documentProcessorServiceClient.GetProcessorAsync(name);

GetProcessorAsync(ProcessorName, CancellationToken)

public virtual Task<Processor> GetProcessorAsync(ProcessorName name, CancellationToken cancellationToken)

Gets a processor detail.

Parameters
NameDescription
nameProcessorName

Required. The processor resource name.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorName name = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Processor response = await documentProcessorServiceClient.GetProcessorAsync(name);

GetProcessorAsync(string, CallSettings)

public virtual Task<Processor> GetProcessorAsync(string name, CallSettings callSettings = null)

Gets a processor detail.

Parameters
NameDescription
namestring

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
Processor response = await documentProcessorServiceClient.GetProcessorAsync(name);

GetProcessorAsync(string, CancellationToken)

public virtual Task<Processor> GetProcessorAsync(string name, CancellationToken cancellationToken)

Gets a processor detail.

Parameters
NameDescription
namestring

Required. The processor resource name.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessor

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
Processor response = await documentProcessorServiceClient.GetProcessorAsync(name);

GetProcessorType(GetProcessorTypeRequest, CallSettings)

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

Gets a processor type detail.

Parameters
NameDescription
requestGetProcessorTypeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessorType

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
GetProcessorTypeRequest request = new GetProcessorTypeRequest
{
    ProcessorTypeName = ProcessorTypeName.FromProjectLocationProcessorType("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]"),
};
// Make the request
ProcessorType response = documentProcessorServiceClient.GetProcessorType(request);

GetProcessorType(ProcessorTypeName, CallSettings)

public virtual ProcessorType GetProcessorType(ProcessorTypeName name, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
NameDescription
nameProcessorTypeName

Required. The processor type resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessorType

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorTypeName name = ProcessorTypeName.FromProjectLocationProcessorType("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]");
// Make the request
ProcessorType response = documentProcessorServiceClient.GetProcessorType(name);

GetProcessorType(string, CallSettings)

public virtual ProcessorType GetProcessorType(string name, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
NameDescription
namestring

Required. The processor type resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessorType

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processorTypes/[PROCESSOR_TYPE]";
// Make the request
ProcessorType response = documentProcessorServiceClient.GetProcessorType(name);

GetProcessorTypeAsync(GetProcessorTypeRequest, CallSettings)

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

Gets a processor type detail.

Parameters
NameDescription
requestGetProcessorTypeRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessorType

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetProcessorTypeRequest request = new GetProcessorTypeRequest
{
    ProcessorTypeName = ProcessorTypeName.FromProjectLocationProcessorType("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]"),
};
// Make the request
ProcessorType response = await documentProcessorServiceClient.GetProcessorTypeAsync(request);

GetProcessorTypeAsync(GetProcessorTypeRequest, CancellationToken)

public virtual Task<ProcessorType> GetProcessorTypeAsync(GetProcessorTypeRequest request, CancellationToken cancellationToken)

Gets a processor type detail.

Parameters
NameDescription
requestGetProcessorTypeRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessorType

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetProcessorTypeRequest request = new GetProcessorTypeRequest
{
    ProcessorTypeName = ProcessorTypeName.FromProjectLocationProcessorType("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]"),
};
// Make the request
ProcessorType response = await documentProcessorServiceClient.GetProcessorTypeAsync(request);

GetProcessorTypeAsync(ProcessorTypeName, CallSettings)

public virtual Task<ProcessorType> GetProcessorTypeAsync(ProcessorTypeName name, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
NameDescription
nameProcessorTypeName

Required. The processor type resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessorType

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorTypeName name = ProcessorTypeName.FromProjectLocationProcessorType("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]");
// Make the request
ProcessorType response = await documentProcessorServiceClient.GetProcessorTypeAsync(name);

GetProcessorTypeAsync(ProcessorTypeName, CancellationToken)

public virtual Task<ProcessorType> GetProcessorTypeAsync(ProcessorTypeName name, CancellationToken cancellationToken)

Gets a processor type detail.

Parameters
NameDescription
nameProcessorTypeName

Required. The processor type resource name.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessorType

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorTypeName name = ProcessorTypeName.FromProjectLocationProcessorType("[PROJECT]", "[LOCATION]", "[PROCESSOR_TYPE]");
// Make the request
ProcessorType response = await documentProcessorServiceClient.GetProcessorTypeAsync(name);

GetProcessorTypeAsync(string, CallSettings)

public virtual Task<ProcessorType> GetProcessorTypeAsync(string name, CallSettings callSettings = null)

Gets a processor type detail.

Parameters
NameDescription
namestring

Required. The processor type resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessorType

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processorTypes/[PROCESSOR_TYPE]";
// Make the request
ProcessorType response = await documentProcessorServiceClient.GetProcessorTypeAsync(name);

GetProcessorTypeAsync(string, CancellationToken)

public virtual Task<ProcessorType> GetProcessorTypeAsync(string name, CancellationToken cancellationToken)

Gets a processor type detail.

Parameters
NameDescription
namestring

Required. The processor type resource name.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessorType

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processorTypes/[PROCESSOR_TYPE]";
// Make the request
ProcessorType response = await documentProcessorServiceClient.GetProcessorTypeAsync(name);

GetProcessorVersion(GetProcessorVersionRequest, CallSettings)

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

Gets a processor version detail.

Parameters
NameDescription
requestGetProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessorVersion

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
GetProcessorVersionRequest request = new GetProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
ProcessorVersion response = documentProcessorServiceClient.GetProcessorVersion(request);

GetProcessorVersion(ProcessorVersionName, CallSettings)

public virtual ProcessorVersion GetProcessorVersion(ProcessorVersionName name, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
NameDescription
nameProcessorVersionName

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessorVersion

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
ProcessorVersion response = documentProcessorServiceClient.GetProcessorVersion(name);

GetProcessorVersion(string, CallSettings)

public virtual ProcessorVersion GetProcessorVersion(string name, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
NameDescription
namestring

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessorVersion

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
ProcessorVersion response = documentProcessorServiceClient.GetProcessorVersion(name);

GetProcessorVersionAsync(GetProcessorVersionRequest, CallSettings)

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

Gets a processor version detail.

Parameters
NameDescription
requestGetProcessorVersionRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessorVersion

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetProcessorVersionRequest request = new GetProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
ProcessorVersion response = await documentProcessorServiceClient.GetProcessorVersionAsync(request);

GetProcessorVersionAsync(GetProcessorVersionRequest, CancellationToken)

public virtual Task<ProcessorVersion> GetProcessorVersionAsync(GetProcessorVersionRequest request, CancellationToken cancellationToken)

Gets a processor version detail.

Parameters
NameDescription
requestGetProcessorVersionRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessorVersion

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
GetProcessorVersionRequest request = new GetProcessorVersionRequest
{
    ProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
ProcessorVersion response = await documentProcessorServiceClient.GetProcessorVersionAsync(request);

GetProcessorVersionAsync(ProcessorVersionName, CallSettings)

public virtual Task<ProcessorVersion> GetProcessorVersionAsync(ProcessorVersionName name, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
NameDescription
nameProcessorVersionName

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessorVersion

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
ProcessorVersion response = await documentProcessorServiceClient.GetProcessorVersionAsync(name);

GetProcessorVersionAsync(ProcessorVersionName, CancellationToken)

public virtual Task<ProcessorVersion> GetProcessorVersionAsync(ProcessorVersionName name, CancellationToken cancellationToken)

Gets a processor version detail.

Parameters
NameDescription
nameProcessorVersionName

Required. The processor resource name.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessorVersion

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName name = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
ProcessorVersion response = await documentProcessorServiceClient.GetProcessorVersionAsync(name);

GetProcessorVersionAsync(string, CallSettings)

public virtual Task<ProcessorVersion> GetProcessorVersionAsync(string name, CallSettings callSettings = null)

Gets a processor version detail.

Parameters
NameDescription
namestring

Required. The processor resource name.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessorVersion

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
ProcessorVersion response = await documentProcessorServiceClient.GetProcessorVersionAsync(name);

GetProcessorVersionAsync(string, CancellationToken)

public virtual Task<ProcessorVersion> GetProcessorVersionAsync(string name, CancellationToken cancellationToken)

Gets a processor version detail.

Parameters
NameDescription
namestring

Required. The processor resource name.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessorVersion

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
ProcessorVersion response = await documentProcessorServiceClient.GetProcessorVersionAsync(name);

ListEvaluations(ListEvaluationsRequest, CallSettings)

public virtual PagedEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluations(ListEvaluationsRequest request, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
NameDescription
requestListEvaluationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ListEvaluationsRequest request = new ListEvaluationsRequest
{
    ParentAsProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
PagedEnumerable<ListEvaluationsResponse, Evaluation> response = documentProcessorServiceClient.ListEvaluations(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Evaluation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEvaluationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluations(ProcessorVersionName, string, int?, CallSettings)

public virtual PagedEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluations(ProcessorVersionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
NameDescription
parentProcessorVersionName

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorVersionName parent = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
PagedEnumerable<ListEvaluationsResponse, Evaluation> response = documentProcessorServiceClient.ListEvaluations(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Evaluation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEvaluationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluations(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluations(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
NameDescription
parentstring

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListEvaluationsResponseEvaluation

A pageable sequence of Evaluation resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
PagedEnumerable<ListEvaluationsResponse, Evaluation> response = documentProcessorServiceClient.ListEvaluations(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Evaluation item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEvaluationsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationsAsync(ListEvaluationsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluationsAsync(ListEvaluationsRequest request, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
NameDescription
requestListEvaluationsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ListEvaluationsRequest request = new ListEvaluationsRequest
{
    ParentAsProcessorVersionName = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]"),
};
// Make the request
PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> response = documentProcessorServiceClient.ListEvaluationsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Evaluation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEvaluationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationsAsync(ProcessorVersionName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluationsAsync(ProcessorVersionName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
NameDescription
parentProcessorVersionName

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorVersionName parent = ProcessorVersionName.FromProjectLocationProcessorProcessorVersion("[PROJECT]", "[LOCATION]", "[PROCESSOR]", "[PROCESSOR_VERSION]");
// Make the request
PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> response = documentProcessorServiceClient.ListEvaluationsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Evaluation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEvaluationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEvaluationsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> ListEvaluationsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves a set of evaluations for a given processor version.

Parameters
NameDescription
parentstring

Required. The resource name of the [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListEvaluationsResponseEvaluation

A pageable asynchronous sequence of Evaluation resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/processorVersions/[PROCESSOR_VERSION]";
// Make the request
PagedAsyncEnumerable<ListEvaluationsResponse, Evaluation> response = documentProcessorServiceClient.ListEvaluationsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Evaluation item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEvaluationsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Evaluation item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Evaluation> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Evaluation item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessors(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListProcessorsResponse, Processor> ListProcessors(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
NameDescription
parentLocationName

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorsResponseProcessor

A pageable sequence of Processor resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessors(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Processor item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Processor item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Processor> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Processor item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessors(ListProcessorsRequest, CallSettings)

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

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorsResponseProcessor

A pageable sequence of Processor resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ListProcessorsRequest request = new ListProcessorsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessors(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Processor item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Processor item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Processor> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Processor item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessors(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListProcessorsResponse, Processor> ListProcessors(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
NameDescription
parentstring

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorsResponseProcessor

A pageable sequence of Processor resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessors(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Processor item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Processor item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Processor> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Processor item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListProcessorsResponse, Processor> ListProcessorsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
NameDescription
parentLocationName

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorsResponseProcessor

A pageable asynchronous sequence of Processor resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessorsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Processor item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Processor item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Processor> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Processor item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorsAsync(ListProcessorsRequest, CallSettings)

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

Lists all processors which belong to this project.

Parameters
NameDescription
requestListProcessorsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorsResponseProcessor

A pageable asynchronous sequence of Processor resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ListProcessorsRequest request = new ListProcessorsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessorsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Processor item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Processor item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Processor> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Processor item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListProcessorsResponse, Processor> ListProcessorsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all processors which belong to this project.

Parameters
NameDescription
parentstring

Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorsResponseProcessor

A pageable asynchronous sequence of Processor resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListProcessorsResponse, Processor> response = documentProcessorServiceClient.ListProcessorsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Processor item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Processor item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Processor> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Processor item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorTypes(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypes(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
NameDescription
parentLocationName

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorTypesResponseProcessorType

A pageable sequence of ProcessorType resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListProcessorTypesResponse, ProcessorType> response = documentProcessorServiceClient.ListProcessorTypes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ProcessorType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorTypes(ListProcessorTypesRequest, CallSettings)

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

Lists the processor types that exist.

Parameters
NameDescription
requestListProcessorTypesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorTypesResponseProcessorType

A pageable sequence of ProcessorType resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ListProcessorTypesRequest request = new ListProcessorTypesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListProcessorTypesResponse, ProcessorType> response = documentProcessorServiceClient.ListProcessorTypes(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ProcessorType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorTypes(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypes(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
NameDescription
parentstring

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorTypesResponseProcessorType

A pageable sequence of ProcessorType resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListProcessorTypesResponse, ProcessorType> response = documentProcessorServiceClient.ListProcessorTypes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ProcessorType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorTypesAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
NameDescription
parentLocationName

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorTypesResponseProcessorType

A pageable asynchronous sequence of ProcessorType resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> response = documentProcessorServiceClient.ListProcessorTypesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ProcessorType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorTypesAsync(ListProcessorTypesRequest, CallSettings)

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

Lists the processor types that exist.

Parameters
NameDescription
requestListProcessorTypesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorTypesResponseProcessorType

A pageable asynchronous sequence of ProcessorType resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ListProcessorTypesRequest request = new ListProcessorTypesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> response = documentProcessorServiceClient.ListProcessorTypesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ProcessorType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorTypesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> ListProcessorTypesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the processor types that exist.

Parameters
NameDescription
parentstring

Required. The location of processor types to list. Format: projects/{project}/locations/{location}.

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorTypesResponseProcessorType

A pageable asynchronous sequence of ProcessorType resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListProcessorTypesResponse, ProcessorType> response = documentProcessorServiceClient.ListProcessorTypesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ProcessorType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorVersions(ListProcessorVersionsRequest, CallSettings)

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

Lists all versions of a processor.

Parameters
NameDescription
requestListProcessorVersionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorVersionsResponseProcessorVersion

A pageable sequence of ProcessorVersion resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ListProcessorVersionsRequest request = new ListProcessorVersionsRequest
{
    ParentAsProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> response = documentProcessorServiceClient.ListProcessorVersions(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ProcessorVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorVersions(ProcessorName, string, int?, CallSettings)

public virtual PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersions(ProcessorName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
NameDescription
parentProcessorName

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorVersionsResponseProcessorVersion

A pageable sequence of ProcessorVersion resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessorName parent = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> response = documentProcessorServiceClient.ListProcessorVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ProcessorVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorVersions(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersions(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
NameDescription
parentstring

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListProcessorVersionsResponseProcessorVersion

A pageable sequence of ProcessorVersion resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
PagedEnumerable<ListProcessorVersionsResponse, ProcessorVersion> response = documentProcessorServiceClient.ListProcessorVersions(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (ProcessorVersion item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListProcessorVersionsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorVersion> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorVersionsAsync(ListProcessorVersionsRequest, CallSettings)

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

Lists all versions of a processor.

Parameters
NameDescription
requestListProcessorVersionsRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorVersionsResponseProcessorVersion

A pageable asynchronous sequence of ProcessorVersion resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ListProcessorVersionsRequest request = new ListProcessorVersionsRequest
{
    ParentAsProcessorName = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
};
// Make the request
PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> response = documentProcessorServiceClient.ListProcessorVersionsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ProcessorVersion item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorVersionsAsync(ProcessorName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersionsAsync(ProcessorName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
NameDescription
parentProcessorName

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorVersionsResponseProcessorVersion

A pageable asynchronous sequence of ProcessorVersion resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessorName parent = ProcessorName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> response = documentProcessorServiceClient.ListProcessorVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ProcessorVersion item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListProcessorVersionsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> ListProcessorVersionsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all versions of a processor.

Parameters
NameDescription
parentstring

Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}

pageTokenstring

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeint

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListProcessorVersionsResponseProcessorVersion

A pageable asynchronous sequence of ProcessorVersion resources.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]";
// Make the request
PagedAsyncEnumerable<ListProcessorVersionsResponse, ProcessorVersion> response = documentProcessorServiceClient.ListProcessorVersionsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ProcessorVersion item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListProcessorVersionsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ProcessorVersion item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<ProcessorVersion> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (ProcessorVersion item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceBatchProcessDocuments(string, CallSettings)

public virtual Operation<BatchProcessResponse, BatchProcessMetadata> PollOnceBatchProcessDocuments(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchProcessDocuments .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationBatchProcessResponseBatchProcessMetadata

The result of polling the operation.

PollOnceBatchProcessDocumentsAsync(string, CallSettings)

public virtual Task<Operation<BatchProcessResponse, BatchProcessMetadata>> PollOnceBatchProcessDocumentsAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchProcessDocuments.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationBatchProcessResponseBatchProcessMetadata

A task representing the result of polling the operation.

PollOnceDeleteProcessor(string, CallSettings)

public virtual Operation<Empty, DeleteProcessorMetadata> PollOnceDeleteProcessor(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteProcessor.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorMetadata

The result of polling the operation.

PollOnceDeleteProcessorAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteProcessorMetadata>> PollOnceDeleteProcessorAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteProcessor.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorMetadata

A task representing the result of polling the operation.

PollOnceDeleteProcessorVersion(string, CallSettings)

public virtual Operation<Empty, DeleteProcessorVersionMetadata> PollOnceDeleteProcessorVersion(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyDeleteProcessorVersionMetadata

The result of polling the operation.

PollOnceDeleteProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<Empty, DeleteProcessorVersionMetadata>> PollOnceDeleteProcessorVersionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyDeleteProcessorVersionMetadata

A task representing the result of polling the operation.

PollOnceDeployProcessorVersion(string, CallSettings)

public virtual Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata> PollOnceDeployProcessorVersion(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeployProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

The result of polling the operation.

PollOnceDeployProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<DeployProcessorVersionResponse, DeployProcessorVersionMetadata>> PollOnceDeployProcessorVersionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeployProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDeployProcessorVersionResponseDeployProcessorVersionMetadata

A task representing the result of polling the operation.

PollOnceDisableProcessor(string, CallSettings)

public virtual Operation<DisableProcessorResponse, DisableProcessorMetadata> PollOnceDisableProcessor(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DisableProcessor.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDisableProcessorResponseDisableProcessorMetadata

The result of polling the operation.

PollOnceDisableProcessorAsync(string, CallSettings)

public virtual Task<Operation<DisableProcessorResponse, DisableProcessorMetadata>> PollOnceDisableProcessorAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DisableProcessor.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDisableProcessorResponseDisableProcessorMetadata

A task representing the result of polling the operation.

PollOnceEnableProcessor(string, CallSettings)

public virtual Operation<EnableProcessorResponse, EnableProcessorMetadata> PollOnceEnableProcessor(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of EnableProcessor.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEnableProcessorResponseEnableProcessorMetadata

The result of polling the operation.

PollOnceEnableProcessorAsync(string, CallSettings)

public virtual Task<Operation<EnableProcessorResponse, EnableProcessorMetadata>> PollOnceEnableProcessorAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of EnableProcessor.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEnableProcessorResponseEnableProcessorMetadata

A task representing the result of polling the operation.

PollOnceEvaluateProcessorVersion(string, CallSettings)

public virtual Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata> PollOnceEvaluateProcessorVersion(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of EvaluateProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

The result of polling the operation.

PollOnceEvaluateProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<EvaluateProcessorVersionResponse, EvaluateProcessorVersionMetadata>> PollOnceEvaluateProcessorVersionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of EvaluateProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEvaluateProcessorVersionResponseEvaluateProcessorVersionMetadata

A task representing the result of polling the operation.

PollOnceReviewDocument(string, CallSettings)

public virtual Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> PollOnceReviewDocument(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of ReviewDocument.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationReviewDocumentResponseReviewDocumentOperationMetadata

The result of polling the operation.

PollOnceReviewDocumentAsync(string, CallSettings)

public virtual Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> PollOnceReviewDocumentAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of ReviewDocument.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A task representing the result of polling the operation.

PollOnceSetDefaultProcessorVersion(string, CallSettings)

public virtual Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata> PollOnceSetDefaultProcessorVersion(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of SetDefaultProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationSetDefaultProcessorVersionResponseSetDefaultProcessorVersionMetadata

The result of polling the operation.

PollOnceSetDefaultProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<SetDefaultProcessorVersionResponse, SetDefaultProcessorVersionMetadata>> PollOnceSetDefaultProcessorVersionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of SetDefaultProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationSetDefaultProcessorVersionResponseSetDefaultProcessorVersionMetadata

A task representing the result of polling the operation.

PollOnceTrainProcessorVersion(string, CallSettings)

public virtual Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata> PollOnceTrainProcessorVersion(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of TrainProcessorVersion .

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationTrainProcessorVersionResponseTrainProcessorVersionMetadata

The result of polling the operation.

PollOnceTrainProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<TrainProcessorVersionResponse, TrainProcessorVersionMetadata>> PollOnceTrainProcessorVersionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of TrainProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationTrainProcessorVersionResponseTrainProcessorVersionMetadata

A task representing the result of polling the operation.

PollOnceUndeployProcessorVersion(string, CallSettings)

public virtual Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata> PollOnceUndeployProcessorVersion(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UndeployProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationUndeployProcessorVersionResponseUndeployProcessorVersionMetadata

The result of polling the operation.

PollOnceUndeployProcessorVersionAsync(string, CallSettings)

public virtual Task<Operation<UndeployProcessorVersionResponse, UndeployProcessorVersionMetadata>> PollOnceUndeployProcessorVersionAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UndeployProcessorVersion.

Parameters
NameDescription
operationNamestring

The name of a previously invoked operation. Must not be null or empty.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationUndeployProcessorVersionResponseUndeployProcessorVersionMetadata

A task representing the result of polling the operation.

ProcessDocument(IResourceName, CallSettings)

public virtual ProcessResponse ProcessDocument(IResourceName name, CallSettings callSettings = null)

Processes a single document.

Parameters
NameDescription
nameIResourceName

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessResponse

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
ProcessResponse response = documentProcessorServiceClient.ProcessDocument(name);

ProcessDocument(ProcessRequest, CallSettings)

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

Processes a single document.

Parameters
NameDescription
requestProcessRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessResponse

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ProcessRequest request = new ProcessRequest
{
    ResourceName = new UnparsedResourceName("a/wildcard/resource"),
    SkipHumanReview = false,
    InlineDocument = new Document(),
    FieldMask = new FieldMask(),
};
// Make the request
ProcessResponse response = documentProcessorServiceClient.ProcessDocument(request);

ProcessDocument(string, CallSettings)

public virtual ProcessResponse ProcessDocument(string name, CallSettings callSettings = null)

Processes a single document.

Parameters
NameDescription
namestring

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ProcessResponse

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string name = "a/wildcard/resource";
// Make the request
ProcessResponse response = documentProcessorServiceClient.ProcessDocument(name);

ProcessDocumentAsync(IResourceName, CallSettings)

public virtual Task<ProcessResponse> ProcessDocumentAsync(IResourceName name, CallSettings callSettings = null)

Processes a single document.

Parameters
NameDescription
nameIResourceName

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
ProcessResponse response = await documentProcessorServiceClient.ProcessDocumentAsync(name);

ProcessDocumentAsync(IResourceName, CancellationToken)

public virtual Task<ProcessResponse> ProcessDocumentAsync(IResourceName name, CancellationToken cancellationToken)

Processes a single document.

Parameters
NameDescription
nameIResourceName

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
IResourceName name = new UnparsedResourceName("a/wildcard/resource");
// Make the request
ProcessResponse response = await documentProcessorServiceClient.ProcessDocumentAsync(name);

ProcessDocumentAsync(ProcessRequest, CallSettings)

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

Processes a single document.

Parameters
NameDescription
requestProcessRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessRequest request = new ProcessRequest
{
    ResourceName = new UnparsedResourceName("a/wildcard/resource"),
    SkipHumanReview = false,
    InlineDocument = new Document(),
    FieldMask = new FieldMask(),
};
// Make the request
ProcessResponse response = await documentProcessorServiceClient.ProcessDocumentAsync(request);

ProcessDocumentAsync(ProcessRequest, CancellationToken)

public virtual Task<ProcessResponse> ProcessDocumentAsync(ProcessRequest request, CancellationToken cancellationToken)

Processes a single document.

Parameters
NameDescription
requestProcessRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ProcessRequest request = new ProcessRequest
{
    ResourceName = new UnparsedResourceName("a/wildcard/resource"),
    SkipHumanReview = false,
    InlineDocument = new Document(),
    FieldMask = new FieldMask(),
};
// Make the request
ProcessResponse response = await documentProcessorServiceClient.ProcessDocumentAsync(request);

ProcessDocumentAsync(string, CallSettings)

public virtual Task<ProcessResponse> ProcessDocumentAsync(string name, CallSettings callSettings = null)

Processes a single document.

Parameters
NameDescription
namestring

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskProcessResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "a/wildcard/resource";
// Make the request
ProcessResponse response = await documentProcessorServiceClient.ProcessDocumentAsync(name);

ProcessDocumentAsync(string, CancellationToken)

public virtual Task<ProcessResponse> ProcessDocumentAsync(string name, CancellationToken cancellationToken)

Processes a single document.

Parameters
NameDescription
namestring

Required. The resource name of the [Processor][google.cloud.documentai.v1.Processor] or [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion] to use for processing. If a [Processor][google.cloud.documentai.v1.Processor] is specified, the server will use its [default version][google.cloud.documentai.v1.Processor.default_processor_version]. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskProcessResponse

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "a/wildcard/resource";
// Make the request
ProcessResponse response = await documentProcessorServiceClient.ProcessDocumentAsync(name);

ReviewDocument(HumanReviewConfigName, CallSettings)

public virtual Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> ReviewDocument(HumanReviewConfigName humanReviewConfig, CallSettings callSettings = null)

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

Parameters
NameDescription
humanReviewConfigHumanReviewConfigName

Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationReviewDocumentResponseReviewDocumentOperationMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
HumanReviewConfigName humanReviewConfig = HumanReviewConfigName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = documentProcessorServiceClient.ReviewDocument(humanReviewConfig);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceReviewDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocument(ReviewDocumentRequest, CallSettings)

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

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

Parameters
NameDescription
requestReviewDocumentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationReviewDocumentResponseReviewDocumentOperationMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
ReviewDocumentRequest request = new ReviewDocumentRequest
{
    HumanReviewConfigAsHumanReviewConfigName = HumanReviewConfigName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
    EnableSchemaValidation = false,
    InlineDocument = new Document(),
    Priority = ReviewDocumentRequest.Types.Priority.Default,
    DocumentSchema = new DocumentSchema(),
};
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = documentProcessorServiceClient.ReviewDocument(request);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceReviewDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocument(string, CallSettings)

public virtual Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> ReviewDocument(string humanReviewConfig, CallSettings callSettings = null)

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

Parameters
NameDescription
humanReviewConfigstring

Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationReviewDocumentResponseReviewDocumentOperationMetadata

The RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = DocumentProcessorServiceClient.Create();
// Initialize request argument(s)
string humanReviewConfig = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/humanReviewConfig";
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = documentProcessorServiceClient.ReviewDocument(humanReviewConfig);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = documentProcessorServiceClient.PollOnceReviewDocument(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocumentAsync(HumanReviewConfigName, CallSettings)

public virtual Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(HumanReviewConfigName humanReviewConfig, CallSettings callSettings = null)

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

Parameters
NameDescription
humanReviewConfigHumanReviewConfigName

Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
HumanReviewConfigName humanReviewConfig = HumanReviewConfigName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = await documentProcessorServiceClient.ReviewDocumentAsync(humanReviewConfig);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceReviewDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocumentAsync(HumanReviewConfigName, CancellationToken)

public virtual Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(HumanReviewConfigName humanReviewConfig, CancellationToken cancellationToken)

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

Parameters
NameDescription
humanReviewConfigHumanReviewConfigName

Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
HumanReviewConfigName humanReviewConfig = HumanReviewConfigName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]");
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = await documentProcessorServiceClient.ReviewDocumentAsync(humanReviewConfig);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceReviewDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocumentAsync(ReviewDocumentRequest, CallSettings)

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

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

Parameters
NameDescription
requestReviewDocumentRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ReviewDocumentRequest request = new ReviewDocumentRequest
{
    HumanReviewConfigAsHumanReviewConfigName = HumanReviewConfigName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
    EnableSchemaValidation = false,
    InlineDocument = new Document(),
    Priority = ReviewDocumentRequest.Types.Priority.Default,
    DocumentSchema = new DocumentSchema(),
};
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = await documentProcessorServiceClient.ReviewDocumentAsync(request);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceReviewDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocumentAsync(ReviewDocumentRequest, CancellationToken)

public virtual Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(ReviewDocumentRequest request, CancellationToken cancellationToken)

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

Parameters
NameDescription
requestReviewDocumentRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
ReviewDocumentRequest request = new ReviewDocumentRequest
{
    HumanReviewConfigAsHumanReviewConfigName = HumanReviewConfigName.FromProjectLocationProcessor("[PROJECT]", "[LOCATION]", "[PROCESSOR]"),
    EnableSchemaValidation = false,
    InlineDocument = new Document(),
    Priority = ReviewDocumentRequest.Types.Priority.Default,
    DocumentSchema = new DocumentSchema(),
};
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = await documentProcessorServiceClient.ReviewDocumentAsync(request);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceReviewDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocumentAsync(string, CallSettings)

public virtual Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(string humanReviewConfig, CallSettings callSettings = null)

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

Parameters
NameDescription
humanReviewConfigstring

Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string humanReviewConfig = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/humanReviewConfig";
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = await documentProcessorServiceClient.ReviewDocumentAsync(humanReviewConfig);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceReviewDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

ReviewDocumentAsync(string, CancellationToken)

public virtual Task<Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata>> ReviewDocumentAsync(string humanReviewConfig, CancellationToken cancellationToken)

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

Parameters
NameDescription
humanReviewConfigstring

Required. The resource name of the [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the document will be reviewed with.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationReviewDocumentResponseReviewDocumentOperationMetadata

A Task containing the RPC response.

Example
// Create client
DocumentProcessorServiceClient documentProcessorServiceClient = await DocumentProcessorServiceClient.CreateAsync();
// Initialize request argument(s)
string humanReviewConfig = "projects/[PROJECT]/locations/[LOCATION]/processors/[PROCESSOR]/humanReviewConfig";
// Make the request
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> response = await documentProcessorServiceClient.ReviewDocumentAsync(humanReviewConfig);

// Poll until the returned long-running operation is complete
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
ReviewDocumentResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<ReviewDocumentResponse, ReviewDocumentOperationMetadata> retrievedResponse = await documentProcessorServiceClient.PollOnceReviewDocumentAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    ReviewDocumentResponse retrievedResult = retrievedResponse.Result;
}

SetDefaultProcessorVersion(SetDefaultProcessorVersionRequest, CallSettings)

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

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

Parameters