Capacity Planner v1beta API - Class UsageServiceSettings (1.0.0-beta01)

public sealed class UsageServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Capacity Planner v1beta API class UsageServiceSettings.

Settings for UsageServiceClient instances.

Inheritance

object > ServiceSettingsBase > UsageServiceSettings

Namespace

Google.Cloud.CapacityPlanner.V1Beta

Assembly

Google.Cloud.CapacityPlanner.V1Beta.dll

Constructors

UsageServiceSettings()

public UsageServiceSettings()

Constructs a new UsageServiceSettings object with default settings.

Properties

ExportForecastsOperationsSettings

public OperationsSettings ExportForecastsOperationsSettings { get; set; }

Long Running Operation settings for calls to UsageServiceClient.ExportForecasts and UsageServiceClient.ExportForecastsAsync.

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.

ExportForecastsSettings

public CallSettings ExportForecastsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UsageServiceClient.ExportForecasts and UsageServiceClient.ExportForecastsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded, Internal.
  • Timeout: 60 seconds.

ExportReservationsUsageOperationsSettings

public OperationsSettings ExportReservationsUsageOperationsSettings { get; set; }

Long Running Operation settings for calls to UsageServiceClient.ExportReservationsUsage and UsageServiceClient.ExportReservationsUsageAsync.

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.

ExportReservationsUsageSettings

public CallSettings ExportReservationsUsageSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UsageServiceClient.ExportReservationsUsage and UsageServiceClient.ExportReservationsUsageAsync .

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded, Internal.
  • Timeout: 60 seconds.

ExportUsageHistoriesOperationsSettings

public OperationsSettings ExportUsageHistoriesOperationsSettings { get; set; }

Long Running Operation settings for calls to UsageServiceClient.ExportUsageHistories and UsageServiceClient.ExportUsageHistoriesAsync.

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.

ExportUsageHistoriesSettings

public CallSettings ExportUsageHistoriesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UsageServiceClient.ExportUsageHistories and UsageServiceClient.ExportUsageHistoriesAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded, Internal.
  • Timeout: 60 seconds.

QueryForecastsSettings

public CallSettings QueryForecastsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UsageServiceClient.QueryForecasts and UsageServiceClient.QueryForecastsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded, Internal.
  • Timeout: 60 seconds.

QueryReservationsSettings

public CallSettings QueryReservationsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UsageServiceClient.QueryReservations and UsageServiceClient.QueryReservationsAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded, Internal.
  • Timeout: 60 seconds.

QueryUsageHistoriesSettings

public CallSettings QueryUsageHistoriesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UsageServiceClient.QueryUsageHistories and UsageServiceClient.QueryUsageHistoriesAsync.

Property Value
Type Description
CallSettings
Remarks
  • Initial retry delay: 1000 milliseconds.
  • Retry delay multiplier: 1.3
  • Retry maximum delay: 60000 milliseconds.
  • Maximum attempts: Unlimited
  • Retriable status codes: Unavailable, DeadlineExceeded, Internal.
  • Timeout: 60 seconds.

Methods

Clone()

public UsageServiceSettings Clone()

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

Returns
Type Description
UsageServiceSettings

A deep clone of this UsageServiceSettings object.

GetDefault()

public static UsageServiceSettings GetDefault()

Get a new instance of the default UsageServiceSettings.

Returns
Type Description
UsageServiceSettings

A new instance of the default UsageServiceSettings.