Observability v1 API - Class ObservabilitySettings (1.0.0-beta01)

public sealed class ObservabilitySettings : ServiceSettingsBase

Reference documentation and code samples for the Observability v1 API class ObservabilitySettings.

Settings for ObservabilityClient instances.

Inheritance

object > ServiceSettingsBase > ObservabilitySettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Observability.V1

Assembly

Google.Cloud.Observability.V1.dll

Constructors

ObservabilitySettings()

public ObservabilitySettings()

Constructs a new ObservabilitySettings object with default settings.

Properties

CreateBucketOperationsSettings

public OperationsSettings CreateBucketOperationsSettings { get; set; }

Long Running Operation settings for calls to ObservabilityClient.CreateBucket and ObservabilityClient.CreateBucketAsync.

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.

CreateBucketSettings

public CallSettings CreateBucketSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.CreateBucket and ObservabilityClient.CreateBucketAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

CreateLinkOperationsSettings

public OperationsSettings CreateLinkOperationsSettings { get; set; }

Long Running Operation settings for calls to ObservabilityClient.CreateLink and ObservabilityClient.CreateLinkAsync.

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.

CreateLinkSettings

public CallSettings CreateLinkSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.CreateLink and ObservabilityClient.CreateLinkAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

CreateTraceScopeSettings

public CallSettings CreateTraceScopeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.CreateTraceScope and ObservabilityClient.CreateTraceScopeAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

DeleteLinkOperationsSettings

public OperationsSettings DeleteLinkOperationsSettings { get; set; }

Long Running Operation settings for calls to ObservabilityClient.DeleteLink and ObservabilityClient.DeleteLinkAsync.

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.

DeleteLinkSettings

public CallSettings DeleteLinkSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.DeleteLink and ObservabilityClient.DeleteLinkAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

DeleteTraceScopeSettings

public CallSettings DeleteTraceScopeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.DeleteTraceScope and ObservabilityClient.DeleteTraceScopeAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

GetBucketSettings

public CallSettings GetBucketSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetBucket and ObservabilityClient.GetBucketAsync.

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.

GetDatasetSettings

public CallSettings GetDatasetSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetDataset and ObservabilityClient.GetDatasetAsync.

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.

GetLinkSettings

public CallSettings GetLinkSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetLink and ObservabilityClient.GetLinkAsync.

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.

GetScopeSettings

public CallSettings GetScopeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetScope and ObservabilityClient.GetScopeAsync.

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.

GetSettingsSettings

public CallSettings GetSettingsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetSettings and ObservabilityClient.GetSettingsAsync.

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.

GetTraceScopeSettings

public CallSettings GetTraceScopeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetTraceScope and ObservabilityClient.GetTraceScopeAsync.

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.

GetViewSettings

public CallSettings GetViewSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.GetView and ObservabilityClient.GetViewAsync.

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.

ListBucketsSettings

public CallSettings ListBucketsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.ListBuckets and ObservabilityClient.ListBucketsAsync.

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.

ListDatasetsSettings

public CallSettings ListDatasetsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.ListDatasets and ObservabilityClient.ListDatasetsAsync.

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.

ListLinksSettings

public CallSettings ListLinksSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.ListLinks and ObservabilityClient.ListLinksAsync.

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.

ListTraceScopesSettings

public CallSettings ListTraceScopesSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.ListTraceScopes and ObservabilityClient.ListTraceScopesAsync.

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.

ListViewsSettings

public CallSettings ListViewsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.ListViews and ObservabilityClient.ListViewsAsync.

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

UpdateBucketOperationsSettings

public OperationsSettings UpdateBucketOperationsSettings { get; set; }

Long Running Operation settings for calls to ObservabilityClient.UpdateBucket and ObservabilityClient.UpdateBucketAsync.

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.

UpdateBucketSettings

public CallSettings UpdateBucketSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.UpdateBucket and ObservabilityClient.UpdateBucketAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

UpdateLinkOperationsSettings

public OperationsSettings UpdateLinkOperationsSettings { get; set; }

Long Running Operation settings for calls to ObservabilityClient.UpdateLink and ObservabilityClient.UpdateLinkAsync.

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.

UpdateLinkSettings

public CallSettings UpdateLinkSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.UpdateLink and ObservabilityClient.UpdateLinkAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

UpdateScopeSettings

public CallSettings UpdateScopeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.UpdateScope and ObservabilityClient.UpdateScopeAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

UpdateSettingsOperationsSettings

public OperationsSettings UpdateSettingsOperationsSettings { get; set; }

Long Running Operation settings for calls to ObservabilityClient.UpdateSettings and ObservabilityClient.UpdateSettingsAsync.

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.

UpdateSettingsSettings

public CallSettings UpdateSettingsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.UpdateSettings and ObservabilityClient.UpdateSettingsAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

UpdateTraceScopeSettings

public CallSettings UpdateTraceScopeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ObservabilityClient.UpdateTraceScope and ObservabilityClient.UpdateTraceScopeAsync.

Property Value
Type	Description
CallSettings

Remarks

• This call will not be retried.
• Timeout: 60 seconds.

Methods

Clone()

public ObservabilitySettings Clone()

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

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

GetDefault()

public static ObservabilitySettings GetDefault()

Get a new instance of the default ObservabilitySettings.

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