Cloud Document AI v1 API - Class DocumentProcessorServiceSettings (3.15.0)

public sealed class DocumentProcessorServiceSettings : ServiceSettingsBase

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

Settings for DocumentProcessorServiceClient instances.

Inheritance

object > ServiceSettingsBase > DocumentProcessorServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

DocumentProcessorServiceSettings()

public DocumentProcessorServiceSettings()

Constructs a new DocumentProcessorServiceSettings object with default settings.

Properties

BatchProcessDocumentsOperationsSettings

public OperationsSettings BatchProcessDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.BatchProcessDocuments and DocumentProcessorServiceClient.BatchProcessDocumentsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

BatchProcessDocumentsSettings

public CallSettings BatchProcessDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.BatchProcessDocuments and DocumentProcessorServiceClient.BatchProcessDocumentsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: DeadlineExceeded, Unavailable.
Timeout: 120 seconds.

CreateProcessorSettings

public CallSettings CreateProcessorSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.CreateProcessor and DocumentProcessorServiceClient.CreateProcessorAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeleteProcessorOperationsSettings

public OperationsSettings DeleteProcessorOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.DeleteProcessor and DocumentProcessorServiceClient.DeleteProcessorAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteProcessorSettings

public CallSettings DeleteProcessorSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.DeleteProcessor and DocumentProcessorServiceClient.DeleteProcessorAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeleteProcessorVersionOperationsSettings

public OperationsSettings DeleteProcessorVersionOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.DeleteProcessorVersion and DocumentProcessorServiceClient.DeleteProcessorVersionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeleteProcessorVersionSettings

public CallSettings DeleteProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.DeleteProcessorVersion and DocumentProcessorServiceClient.DeleteProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DeployProcessorVersionOperationsSettings

public OperationsSettings DeployProcessorVersionOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.DeployProcessorVersion and DocumentProcessorServiceClient.DeployProcessorVersionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DeployProcessorVersionSettings

public CallSettings DeployProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.DeployProcessorVersion and DocumentProcessorServiceClient.DeployProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

DisableProcessorOperationsSettings

public OperationsSettings DisableProcessorOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.DisableProcessor and DocumentProcessorServiceClient.DisableProcessorAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

DisableProcessorSettings

public CallSettings DisableProcessorSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.DisableProcessor and DocumentProcessorServiceClient.DisableProcessorAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

EnableProcessorOperationsSettings

public OperationsSettings EnableProcessorOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.EnableProcessor and DocumentProcessorServiceClient.EnableProcessorAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

EnableProcessorSettings

public CallSettings EnableProcessorSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.EnableProcessor and DocumentProcessorServiceClient.EnableProcessorAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

EvaluateProcessorVersionOperationsSettings

public OperationsSettings EvaluateProcessorVersionOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.EvaluateProcessorVersion and DocumentProcessorServiceClient.EvaluateProcessorVersionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

EvaluateProcessorVersionSettings

public CallSettings EvaluateProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.EvaluateProcessorVersion and DocumentProcessorServiceClient.EvaluateProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

FetchProcessorTypesSettings

public CallSettings FetchProcessorTypesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.FetchProcessorTypes and DocumentProcessorServiceClient.FetchProcessorTypesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetEvaluationSettings

public CallSettings GetEvaluationSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.GetEvaluation and DocumentProcessorServiceClient.GetEvaluationAsync .

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetProcessorSettings

public CallSettings GetProcessorSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.GetProcessor and DocumentProcessorServiceClient.GetProcessorAsync .

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetProcessorTypeSettings

public CallSettings GetProcessorTypeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.GetProcessorType and DocumentProcessorServiceClient.GetProcessorTypeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

GetProcessorVersionSettings

public CallSettings GetProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.GetProcessorVersion and DocumentProcessorServiceClient.GetProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListEvaluationsSettings

public CallSettings ListEvaluationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.ListEvaluations and DocumentProcessorServiceClient.ListEvaluationsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListProcessorTypesSettings

public CallSettings ListProcessorTypesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.ListProcessorTypes and DocumentProcessorServiceClient.ListProcessorTypesAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListProcessorVersionsSettings

public CallSettings ListProcessorVersionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.ListProcessorVersions and DocumentProcessorServiceClient.ListProcessorVersionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

ListProcessorsSettings

public CallSettings ListProcessorsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.ListProcessors and DocumentProcessorServiceClient.ListProcessorsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
`LocationsSettings`

ProcessDocumentSettings

public CallSettings ProcessDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.ProcessDocument and DocumentProcessorServiceClient.ProcessDocumentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: DeadlineExceeded, Unavailable.
Timeout: 300 seconds.

ReviewDocumentOperationsSettings

public OperationsSettings ReviewDocumentOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.ReviewDocument and DocumentProcessorServiceClient.ReviewDocumentAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

ReviewDocumentSettings

public CallSettings ReviewDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.ReviewDocument and DocumentProcessorServiceClient.ReviewDocumentAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: DeadlineExceeded, Unavailable.
Timeout: 120 seconds.

SetDefaultProcessorVersionOperationsSettings

public OperationsSettings SetDefaultProcessorVersionOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.SetDefaultProcessorVersion and DocumentProcessorServiceClient.SetDefaultProcessorVersionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

SetDefaultProcessorVersionSettings

public CallSettings SetDefaultProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.SetDefaultProcessorVersion and DocumentProcessorServiceClient.SetDefaultProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

TrainProcessorVersionOperationsSettings

public OperationsSettings TrainProcessorVersionOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.TrainProcessorVersion and DocumentProcessorServiceClient.TrainProcessorVersionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

TrainProcessorVersionSettings

public CallSettings TrainProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.TrainProcessorVersion and DocumentProcessorServiceClient.TrainProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

UndeployProcessorVersionOperationsSettings

public OperationsSettings UndeployProcessorVersionOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentProcessorServiceClient.UndeployProcessorVersion and DocumentProcessorServiceClient.UndeployProcessorVersionAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

UndeployProcessorVersionSettings

public CallSettings UndeployProcessorVersionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentProcessorServiceClient.UndeployProcessorVersion and DocumentProcessorServiceClient.UndeployProcessorVersionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
No timeout is applied.

Methods

Clone()

public DocumentProcessorServiceSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type	Description
`DocumentProcessorServiceSettings`	A deep clone of this DocumentProcessorServiceSettings object.

GetDefault()

public static DocumentProcessorServiceSettings GetDefault()

Get a new instance of the default DocumentProcessorServiceSettings.

Returns
Type	Description
`DocumentProcessorServiceSettings`	A new instance of the default DocumentProcessorServiceSettings.