Vector Search v1 API - Class VectorSearchServiceSettings (1.0.0-beta01)

public sealed class VectorSearchServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Vector Search v1 API class VectorSearchServiceSettings.

Settings for VectorSearchServiceClient instances.

Inheritance

object > ServiceSettingsBase > VectorSearchServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

VectorSearchServiceSettings()

public VectorSearchServiceSettings()

Constructs a new VectorSearchServiceSettings object with default settings.

Properties

CreateCollectionOperationsSettings

public OperationsSettings CreateCollectionOperationsSettings { get; set; }

Long Running Operation settings for calls to VectorSearchServiceClient.CreateCollection and VectorSearchServiceClient.CreateCollectionAsync.

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.

CreateCollectionSettings

public CallSettings CreateCollectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.CreateCollection and VectorSearchServiceClient.CreateCollectionAsync .

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

CreateIndexOperationsSettings

public OperationsSettings CreateIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to VectorSearchServiceClient.CreateIndex and VectorSearchServiceClient.CreateIndexAsync.

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.

CreateIndexSettings

public CallSettings CreateIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.CreateIndex and VectorSearchServiceClient.CreateIndexAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

DeleteCollectionOperationsSettings

public OperationsSettings DeleteCollectionOperationsSettings { get; set; }

Long Running Operation settings for calls to VectorSearchServiceClient.DeleteCollection and VectorSearchServiceClient.DeleteCollectionAsync.

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.

DeleteCollectionSettings

public CallSettings DeleteCollectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.DeleteCollection and VectorSearchServiceClient.DeleteCollectionAsync .

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

DeleteIndexOperationsSettings

public OperationsSettings DeleteIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to VectorSearchServiceClient.DeleteIndex and VectorSearchServiceClient.DeleteIndexAsync.

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.

DeleteIndexSettings

public CallSettings DeleteIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.DeleteIndex and VectorSearchServiceClient.DeleteIndexAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

GetCollectionSettings

public CallSettings GetCollectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.GetCollection and VectorSearchServiceClient.GetCollectionAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

GetIndexSettings

public CallSettings GetIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.GetIndex and VectorSearchServiceClient.GetIndexAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

ImportDataObjectsOperationsSettings

public OperationsSettings ImportDataObjectsOperationsSettings { get; set; }

Long Running Operation settings for calls to VectorSearchServiceClient.ImportDataObjects and VectorSearchServiceClient.ImportDataObjectsAsync.

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.

ImportDataObjectsSettings

public CallSettings ImportDataObjectsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.ImportDataObjects and VectorSearchServiceClient.ImportDataObjectsAsync .

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

ListCollectionsSettings

public CallSettings ListCollectionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.ListCollections and VectorSearchServiceClient.ListCollectionsAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

ListIndexesSettings

public CallSettings ListIndexesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.ListIndexes and VectorSearchServiceClient.ListIndexesAsync.

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type	Description
LocationsSettings

UpdateCollectionOperationsSettings

public OperationsSettings UpdateCollectionOperationsSettings { get; set; }

Long Running Operation settings for calls to VectorSearchServiceClient.UpdateCollection and VectorSearchServiceClient.UpdateCollectionAsync.

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.

UpdateCollectionSettings

public CallSettings UpdateCollectionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to VectorSearchServiceClient.UpdateCollection and VectorSearchServiceClient.UpdateCollectionAsync .

Property Value
Type	Description
CallSettings

Remarks

• Initial retry delay: 1000 milliseconds.
• Retry delay multiplier: 1.3
• Retry maximum delay: 10000 milliseconds.
• Maximum attempts: 5
• Retriable status codes: Unavailable.
• Timeout: 60 seconds.

Methods

Clone()

public VectorSearchServiceSettings Clone()

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

Returns
Type	Description
VectorSearchServiceSettings	A deep clone of this VectorSearchServiceSettings object.

GetDefault()

public static VectorSearchServiceSettings GetDefault()

Get a new instance of the default VectorSearchServiceSettings.

Returns
Type	Description
VectorSearchServiceSettings	A new instance of the default VectorSearchServiceSettings.