Cloud Pub/Sub v1 API - Class SubscriberServiceApiSettings (3.11.0)

public sealed class SubscriberServiceApiSettings : ServiceSettingsBase

Reference documentation and code samples for the Cloud Pub/Sub v1 API class SubscriberServiceApiSettings.

Settings for SubscriberServiceApiClient instances.

Inheritance

object > ServiceSettingsBase > SubscriberServiceApiSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

SubscriberServiceApiSettings()

public SubscriberServiceApiSettings()

Constructs a new SubscriberServiceApiSettings object with default settings.

Properties

AcknowledgeSettings

public CallSettings AcknowledgeSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.Acknowledge and SubscriberServiceApiClient.AcknowledgeAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateSnapshotSettings

public CallSettings CreateSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.CreateSnapshot and SubscriberServiceApiClient.CreateSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

CreateSubscriptionSettings

public CallSettings CreateSubscriptionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.CreateSubscription and SubscriberServiceApiClient.CreateSubscriptionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable.
Timeout: 60 seconds.

DeleteSnapshotSettings

public CallSettings DeleteSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.DeleteSnapshot and SubscriberServiceApiClient.DeleteSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

DeleteSubscriptionSettings

public CallSettings DeleteSubscriptionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.DeleteSubscription and SubscriberServiceApiClient.DeleteSubscriptionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

GetSnapshotSettings

public CallSettings GetSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.GetSnapshot and SubscriberServiceApiClient.GetSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable.
Timeout: 60 seconds.

GetSubscriptionSettings

public CallSettings GetSubscriptionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.GetSubscription and SubscriberServiceApiClient.GetSubscriptionAsync .

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable.
Timeout: 60 seconds.

IAMPolicySettings

public IAMPolicySettings IAMPolicySettings { get; set; }

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

Property Value
Type	Description
`IAMPolicySettings`

ListSnapshotsSettings

public CallSettings ListSnapshotsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.ListSnapshots and SubscriberServiceApiClient.ListSnapshotsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable.
Timeout: 60 seconds.

ListSubscriptionsSettings

public CallSettings ListSubscriptionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.ListSubscriptions and SubscriberServiceApiClient.ListSubscriptionsAsync .

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable.
Timeout: 60 seconds.

ModifyAckDeadlineSettings

public CallSettings ModifyAckDeadlineSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.ModifyAckDeadline and SubscriberServiceApiClient.ModifyAckDeadlineAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

ModifyPushConfigSettings

public CallSettings ModifyPushConfigSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.ModifyPushConfig and SubscriberServiceApiClient.ModifyPushConfigAsync .

Property Value
Type	Description
`CallSettings`

Remarks

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

PullSettings

public CallSettings PullSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.Pull and SubscriberServiceApiClient.PullAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable, Internal.
Timeout: 60 seconds.

SeekSettings

public CallSettings SeekSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.Seek and SubscriberServiceApiClient.SeekAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 60000 milliseconds.
Maximum attempts: 5
Retriable status codes: Unknown, Aborted, Unavailable.
Timeout: 60 seconds.

StreamingPullSettings

public CallSettings StreamingPullSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.StreamingPull and SubscriberServiceApiClient.StreamingPullAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Timeout: 900 seconds.

StreamingPullStreamingSettings

public BidirectionalStreamingSettings StreamingPullStreamingSettings { get; set; }

BidirectionalStreamingSettings for calls to SubscriberServiceApiClient.StreamingPull and SubscriberServiceApiClient.StreamingPullAsync.

Property Value
Type	Description
`BidirectionalStreamingSettings`

Remarks

The default local send queue size is 100.

UpdateSnapshotSettings

public CallSettings UpdateSnapshotSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.UpdateSnapshot and SubscriberServiceApiClient.UpdateSnapshotAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateSubscriptionSettings

public CallSettings UpdateSubscriptionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SubscriberServiceApiClient.UpdateSubscription and SubscriberServiceApiClient.UpdateSubscriptionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

Methods

Clone()

public SubscriberServiceApiSettings Clone()

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

Returns
Type	Description
`SubscriberServiceApiSettings`	A deep clone of this SubscriberServiceApiSettings object.

GetDefault()

public static SubscriberServiceApiSettings GetDefault()

Get a new instance of the default SubscriberServiceApiSettings.

Returns
Type	Description
`SubscriberServiceApiSettings`	A new instance of the default SubscriberServiceApiSettings.