Cloud Document AI v1beta3 API - Class DocumentServiceSettings (2.0.0-beta27) 

public sealed class DocumentServiceSettings : ServiceSettingsBase

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

Settings for DocumentServiceClient instances.

Inheritance

object > ServiceSettingsBase > DocumentServiceSettings

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

DocumentServiceSettings()

public DocumentServiceSettings()

Constructs a new DocumentServiceSettings object with default settings.

Properties

BatchDeleteDocumentsOperationsSettings

public OperationsSettings BatchDeleteDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentServiceClient.BatchDeleteDocuments and DocumentServiceClient.BatchDeleteDocumentsAsync.

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.

BatchDeleteDocumentsSettings

public CallSettings BatchDeleteDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.BatchDeleteDocuments and DocumentServiceClient.BatchDeleteDocumentsAsync .

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

GetDatasetSchemaSettings

public CallSettings GetDatasetSchemaSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.GetDatasetSchema and DocumentServiceClient.GetDatasetSchemaAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

GetDocumentSettings

public CallSettings GetDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.GetDocument and DocumentServiceClient.GetDocumentAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

ImportDocumentsOperationsSettings

public OperationsSettings ImportDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentServiceClient.ImportDocuments and DocumentServiceClient.ImportDocumentsAsync.

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.

ImportDocumentsSettings

public CallSettings ImportDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.ImportDocuments and DocumentServiceClient.ImportDocumentsAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

ListDocumentsSettings

public CallSettings ListDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.ListDocuments and DocumentServiceClient.ListDocumentsAsync.

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

UpdateDatasetOperationsSettings

public OperationsSettings UpdateDatasetOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentServiceClient.UpdateDataset and DocumentServiceClient.UpdateDatasetAsync.

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.

UpdateDatasetSchemaSettings

public CallSettings UpdateDatasetSchemaSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.UpdateDatasetSchema and DocumentServiceClient.UpdateDatasetSchemaAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

UpdateDatasetSettings

public CallSettings UpdateDatasetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.UpdateDataset and DocumentServiceClient.UpdateDatasetAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • No timeout is applied.

Methods

Clone()

public DocumentServiceSettings Clone()

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

Returns
Type Description
DocumentServiceSettings

A deep clone of this DocumentServiceSettings object.

GetDefault()

public static DocumentServiceSettings GetDefault()

Get a new instance of the default DocumentServiceSettings.

Returns
Type Description
DocumentServiceSettings

A new instance of the default DocumentServiceSettings.