Class SubscriberClient.Settings (3.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class Settings

Settings for SubscriberClient. Defaults will be used for null properties.

Inheritance

Object > SubscriberClient.Settings

Namespace

Google.Cloud.PubSub.V1

Assembly

Google.Cloud.PubSub.V1.dll

Constructors

Settings()

public Settings()

Create a new instance.

Properties

AckDeadline

public TimeSpan? AckDeadline { get; set; }

The lease time before which a message must either be ACKed or have its lease extended. This is truncated to the nearest second. If null, uses the default of DefaultAckDeadline.

Property Value
TypeDescription
Nullable<TimeSpan>

AckExtensionWindow

public TimeSpan? AckExtensionWindow { get; set; }

Duration before AckDeadline at which the message ACK deadline is automatically extended. If null, uses the default of DefaultAckExtensionWindow.

Property Value
TypeDescription
Nullable<TimeSpan>

Clock

public IClock Clock { get; set; }

The IClock used for timeouts and retries. If null, the default SystemClock is used. This is usually only used for testing.

Property Value
TypeDescription
IClock
Remarks

This is used only in exactly once delivery flow as we need to retry temporary failures.

FlowControlSettings

public FlowControlSettings FlowControlSettings { get; set; }

Flow control settings. If null, uses flow control settings from DefaultFlowControlSettings.

Property Value
TypeDescription
FlowControlSettings

MaxTotalAckExtension

public TimeSpan? MaxTotalAckExtension { get; set; }

Maximum duration for which a message ACK deadline will be extended. If null, uses the default of DefaultMaxTotalAckExtension.

Property Value
TypeDescription
Nullable<TimeSpan>

Scheduler

public IScheduler Scheduler { get; set; }

The IScheduler used to schedule delays. If null, the default SystemScheduler is used. This is usually only used for testing.

Property Value
TypeDescription
IScheduler

UseLegacyFlowControl

public bool UseLegacyFlowControl { get; set; }

If set to true, disables enforcing flow control settings at the Cloud PubSub server and uses the less accurate method of only enforcing flow control at the client side.

Property Value
TypeDescription
Boolean

Methods

Clone()

public SubscriberClient.Settings Clone()

Create a clone of this object.

Returns
TypeDescription
SubscriberClient.Settings

A clone of this object.