Class DocumentsSettings (3.8.0)

public sealed class DocumentsSettings : ServiceSettingsBase

Settings for DocumentsClient instances.

Inheritance

Object > ServiceSettingsBase > DocumentsSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

DocumentsSettings()

public DocumentsSettings()

Constructs a new DocumentsSettings object with default settings.

Properties

CreateDocumentOperationsSettings

public OperationsSettings CreateDocumentOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentsClient.CreateDocument and DocumentsClient.CreateDocumentAsync.

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.

CreateDocumentSettings

public CallSettings CreateDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentsClient.CreateDocument and DocumentsClient.CreateDocumentAsync.

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: Unavailable.
Timeout: 60 seconds.

DeleteDocumentOperationsSettings

public OperationsSettings DeleteDocumentOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentsClient.DeleteDocument and DocumentsClient.DeleteDocumentAsync.

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.

DeleteDocumentSettings

public CallSettings DeleteDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentsClient.DeleteDocument and DocumentsClient.DeleteDocumentAsync.

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: Unavailable.
Timeout: 60 seconds.

GetDocumentSettings

public CallSettings GetDocumentSettings { get; set; }

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

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: Unavailable.
Timeout: 60 seconds.

ListDocumentsSettings

public CallSettings ListDocumentsSettings { get; set; }

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

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: Unavailable.
Timeout: 60 seconds.

ReloadDocumentOperationsSettings

public OperationsSettings ReloadDocumentOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentsClient.ReloadDocument and DocumentsClient.ReloadDocumentAsync.

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.

ReloadDocumentSettings

public CallSettings ReloadDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentsClient.ReloadDocument and DocumentsClient.ReloadDocumentAsync.

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: Unavailable.
Timeout: 60 seconds.

UpdateDocumentOperationsSettings

public OperationsSettings UpdateDocumentOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentsClient.UpdateDocument and DocumentsClient.UpdateDocumentAsync.

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.

UpdateDocumentSettings

public CallSettings UpdateDocumentSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentsClient.UpdateDocument and DocumentsClient.UpdateDocumentAsync.

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: Unavailable.
Timeout: 60 seconds.

Methods

Clone()

public DocumentsSettings Clone()

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

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

GetDefault()

public static DocumentsSettings GetDefault()

Get a new instance of the default DocumentsSettings.

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