Vertex AI v1beta1 API - Class IndexServiceSettings (1.0.0-beta61) 

public sealed class IndexServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Vertex AI v1beta1 API class IndexServiceSettings.

Settings for IndexServiceClient instances.

Inheritance

object > ServiceSettingsBase > IndexServiceSettings

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

IndexServiceSettings()

public IndexServiceSettings()

Constructs a new IndexServiceSettings object with default settings.

Properties

CreateIndexOperationsSettings

public OperationsSettings CreateIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to IndexServiceClient.CreateIndex and IndexServiceClient.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 IndexServiceClient.CreateIndex and IndexServiceClient.CreateIndexAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 5 seconds.

DeleteIndexOperationsSettings

public OperationsSettings DeleteIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to IndexServiceClient.DeleteIndex and IndexServiceClient.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 IndexServiceClient.DeleteIndex and IndexServiceClient.DeleteIndexAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 5 seconds.

GetIndexSettings

public CallSettings GetIndexSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 5 seconds.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

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

Property Value
Type Description
IAMPolicySettings

ImportIndexOperationsSettings

public OperationsSettings ImportIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to IndexServiceClient.ImportIndex and IndexServiceClient.ImportIndexAsync.

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.

ImportIndexSettings

public CallSettings ImportIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to IndexServiceClient.ImportIndex and IndexServiceClient.ImportIndexAsync.

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

ListIndexesSettings

public CallSettings ListIndexesSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 5 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

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

Property Value
Type Description
LocationsSettings

RemoveDatapointsSettings

public CallSettings RemoveDatapointsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to IndexServiceClient.RemoveDatapoints and IndexServiceClient.RemoveDatapointsAsync.

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

UpdateIndexOperationsSettings

public OperationsSettings UpdateIndexOperationsSettings { get; set; }

Long Running Operation settings for calls to IndexServiceClient.UpdateIndex and IndexServiceClient.UpdateIndexAsync.

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.

UpdateIndexSettings

public CallSettings UpdateIndexSettings { get; set; }

CallSettings for synchronous and asynchronous calls to IndexServiceClient.UpdateIndex and IndexServiceClient.UpdateIndexAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 5 seconds.

UpsertDatapointsSettings

public CallSettings UpsertDatapointsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to IndexServiceClient.UpsertDatapoints and IndexServiceClient.UpsertDatapointsAsync.

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

Methods

Clone()

public IndexServiceSettings Clone()

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

Returns
Type Description
IndexServiceSettings

A deep clone of this IndexServiceSettings object.

GetDefault()

public static IndexServiceSettings GetDefault()

Get a new instance of the default IndexServiceSettings.

Returns
Type Description
IndexServiceSettings

A new instance of the default IndexServiceSettings.