Discovery Engine v1 API - Class DocumentServiceSettings (1.6.0) 

public sealed class DocumentServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Discovery Engine v1 API class DocumentServiceSettings.

Settings for DocumentServiceClient instances.

Inheritance

object > ServiceSettingsBase > DocumentServiceSettings

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DocumentServiceSettings()

public DocumentServiceSettings()

Constructs a new DocumentServiceSettings object with default settings.

Properties

BatchGetDocumentsMetadataSettings

public CallSettings BatchGetDocumentsMetadataSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.BatchGetDocumentsMetadata and DocumentServiceClient.BatchGetDocumentsMetadataAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

CreateDocumentSettings

public CallSettings CreateDocumentSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

DeleteDocumentSettings

public CallSettings DeleteDocumentSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

GetDocumentSettings

public CallSettings GetDocumentSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

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
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 30000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 300 seconds.

ListDocumentsSettings

public CallSettings ListDocumentsSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type Description
LocationsSettings

PurgeDocumentsOperationsSettings

public OperationsSettings PurgeDocumentsOperationsSettings { get; set; }

Long Running Operation settings for calls to DocumentServiceClient.PurgeDocuments and DocumentServiceClient.PurgeDocumentsAsync.

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.

PurgeDocumentsSettings

public CallSettings PurgeDocumentsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to DocumentServiceClient.PurgeDocuments and DocumentServiceClient.PurgeDocumentsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

UpdateDocumentSettings

public CallSettings UpdateDocumentSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 10000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable.
  • Timeout: 30 seconds.

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.