Cloud Pub/Sub v1 API - Class PublisherServiceApiSettings (3.15.0)

public sealed class PublisherServiceApiSettings : ServiceSettingsBase

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

Settings for PublisherServiceApiClient instances.

Inheritance

object > ServiceSettingsBase > PublisherServiceApiSettings

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

PublisherServiceApiSettings()

public PublisherServiceApiSettings()

Constructs a new PublisherServiceApiSettings object with default settings.

Properties

CreateTopicSettings

public CallSettings CreateTopicSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.CreateTopic and PublisherServiceApiClient.CreateTopicAsync.

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.

DeleteTopicSettings

public CallSettings DeleteTopicSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.DeleteTopic and PublisherServiceApiClient.DeleteTopicAsync.

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.

DetachSubscriptionSettings

public CallSettings DetachSubscriptionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.DetachSubscription and PublisherServiceApiClient.DetachSubscriptionAsync .

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.

GetTopicSettings

public CallSettings GetTopicSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.GetTopic and PublisherServiceApiClient.GetTopicAsync.

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`

ListTopicSnapshotsSettings

public CallSettings ListTopicSnapshotsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.ListTopicSnapshots and PublisherServiceApiClient.ListTopicSnapshotsAsync .

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.

ListTopicSubscriptionsSettings

public CallSettings ListTopicSubscriptionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.ListTopicSubscriptions and PublisherServiceApiClient.ListTopicSubscriptionsAsync.

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.

ListTopicsSettings

public CallSettings ListTopicsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.ListTopics and PublisherServiceApiClient.ListTopicsAsync.

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.

PublishSettings

public CallSettings PublishSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.Publish and PublisherServiceApiClient.PublishAsync.

Property Value
Type	Description
`CallSettings`

Remarks

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

UpdateTopicSettings

public CallSettings UpdateTopicSettings { get; set; }

CallSettings for synchronous and asynchronous calls to PublisherServiceApiClient.UpdateTopic and PublisherServiceApiClient.UpdateTopicAsync.

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 PublisherServiceApiSettings Clone()

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

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

GetDefault()

public static PublisherServiceApiSettings GetDefault()

Get a new instance of the default PublisherServiceApiSettings.

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