API Keys v2 API - Class ApiKeysSettings (1.4.0) 

public sealed class ApiKeysSettings : ServiceSettingsBase

Reference documentation and code samples for the API Keys v2 API class ApiKeysSettings.

Settings for ApiKeysClient instances.

Inheritance

object > ServiceSettingsBase > ApiKeysSettings

Namespace

Google.Cloud.ApiKeys.V2

Assembly

Google.Cloud.ApiKeys.V2.dll

Constructors

ApiKeysSettings()

public ApiKeysSettings()

Constructs a new ApiKeysSettings object with default settings.

Properties

CreateKeyOperationsSettings

public OperationsSettings CreateKeyOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiKeysClient.CreateKey and ApiKeysClient.CreateKeyAsync.

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.

CreateKeySettings

public CallSettings CreateKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.CreateKey and ApiKeysClient.CreateKeyAsync.

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

DeleteKeyOperationsSettings

public OperationsSettings DeleteKeyOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiKeysClient.DeleteKey and ApiKeysClient.DeleteKeyAsync.

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.

DeleteKeySettings

public CallSettings DeleteKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.DeleteKey and ApiKeysClient.DeleteKeyAsync.

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

GetKeySettings

public CallSettings GetKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.GetKey and ApiKeysClient.GetKeyAsync.

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

GetKeyStringSettings

public CallSettings GetKeyStringSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.GetKeyString and ApiKeysClient.GetKeyStringAsync.

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

ListKeysSettings

public CallSettings ListKeysSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.ListKeys and ApiKeysClient.ListKeysAsync.

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

LookupKeySettings

public CallSettings LookupKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.LookupKey and ApiKeysClient.LookupKeyAsync.

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

UndeleteKeyOperationsSettings

public OperationsSettings UndeleteKeyOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiKeysClient.UndeleteKey and ApiKeysClient.UndeleteKeyAsync.

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.

UndeleteKeySettings

public CallSettings UndeleteKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.UndeleteKey and ApiKeysClient.UndeleteKeyAsync.

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

UpdateKeyOperationsSettings

public OperationsSettings UpdateKeyOperationsSettings { get; set; }

Long Running Operation settings for calls to ApiKeysClient.UpdateKey and ApiKeysClient.UpdateKeyAsync.

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.

UpdateKeySettings

public CallSettings UpdateKeySettings { get; set; }

CallSettings for synchronous and asynchronous calls to ApiKeysClient.UpdateKey and ApiKeysClient.UpdateKeyAsync.

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

Methods

Clone()

public ApiKeysSettings Clone()

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

Returns
Type Description
ApiKeysSettings

A deep clone of this ApiKeysSettings object.

GetDefault()

public static ApiKeysSettings GetDefault()

Get a new instance of the default ApiKeysSettings.

Returns
Type Description
ApiKeysSettings

A new instance of the default ApiKeysSettings.