Managed Service for Apache Kafka API v1 API - Class ManagedKafkaSettings (1.0.0-beta01) 

public sealed class ManagedKafkaSettings : ServiceSettingsBase

Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class ManagedKafkaSettings.

Settings for ManagedKafkaClient instances.

Inheritance

object > ServiceSettingsBase > ManagedKafkaSettings

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Constructors

ManagedKafkaSettings()

public ManagedKafkaSettings()

Constructs a new ManagedKafkaSettings object with default settings.

Properties

CreateClusterOperationsSettings

public OperationsSettings CreateClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to ManagedKafkaClient.CreateCluster and ManagedKafkaClient.CreateClusterAsync.

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.

CreateClusterSettings

public CallSettings CreateClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.CreateCluster and ManagedKafkaClient.CreateClusterAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

CreateTopicSettings

public CallSettings CreateTopicSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

DeleteClusterOperationsSettings

public OperationsSettings DeleteClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to ManagedKafkaClient.DeleteCluster and ManagedKafkaClient.DeleteClusterAsync.

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.

DeleteClusterSettings

public CallSettings DeleteClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.DeleteCluster and ManagedKafkaClient.DeleteClusterAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

DeleteConsumerGroupSettings

public CallSettings DeleteConsumerGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.DeleteConsumerGroup and ManagedKafkaClient.DeleteConsumerGroupAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

DeleteTopicSettings

public CallSettings DeleteTopicSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

GetClusterSettings

public CallSettings GetClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.GetCluster and ManagedKafkaClient.GetClusterAsync.

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.

GetConsumerGroupSettings

public CallSettings GetConsumerGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.GetConsumerGroup and ManagedKafkaClient.GetConsumerGroupAsync.

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.

GetTopicSettings

public CallSettings GetTopicSettings { get; set; }

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

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.

ListClustersSettings

public CallSettings ListClustersSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.ListClusters and ManagedKafkaClient.ListClustersAsync.

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.

ListConsumerGroupsSettings

public CallSettings ListConsumerGroupsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.ListConsumerGroups and ManagedKafkaClient.ListConsumerGroupsAsync.

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.

ListTopicsSettings

public CallSettings ListTopicsSettings { get; set; }

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

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

UpdateClusterOperationsSettings

public OperationsSettings UpdateClusterOperationsSettings { get; set; }

Long Running Operation settings for calls to ManagedKafkaClient.UpdateCluster and ManagedKafkaClient.UpdateClusterAsync.

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.

UpdateClusterSettings

public CallSettings UpdateClusterSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.UpdateCluster and ManagedKafkaClient.UpdateClusterAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

UpdateConsumerGroupSettings

public CallSettings UpdateConsumerGroupSettings { get; set; }

CallSettings for synchronous and asynchronous calls to ManagedKafkaClient.UpdateConsumerGroup and ManagedKafkaClient.UpdateConsumerGroupAsync.

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

UpdateTopicSettings

public CallSettings UpdateTopicSettings { get; set; }

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

Property Value
Type Description
CallSettings
Remarks
  • This call will not be retried.
  • Timeout: 60 seconds.

Methods

Clone()

public ManagedKafkaSettings Clone()

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

Returns
Type Description
ManagedKafkaSettings

A deep clone of this ManagedKafkaSettings object.

GetDefault()

public static ManagedKafkaSettings GetDefault()

Get a new instance of the default ManagedKafkaSettings.

Returns
Type Description
ManagedKafkaSettings

A new instance of the default ManagedKafkaSettings.