Class EventHubProducerClientOptions

The set of options that can be specified when creating an EventHubProducerClient to configure its behavior.

Inheritance

System.Object

EventHubProducerClientOptions

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Messaging.EventHubs.dll

Syntax

public class EventHubProducerClientOptions

Constructors

EventHubProducerClientOptions()

Declaration

public EventHubProducerClientOptions ();

Properties

Indicates whether or not the producer should enable idempotent publishing to the Event Hub partitions. If enabled, the producer will only be able to publish directly to partitions; it will not be able to publish to the Event Hubs gateway for automatic partition routing nor using a partition key.

Declaration

[System.ComponentModel.EditorBrowsable]
protected internal bool EnableIdempotentPartitions { get; set; }

Property Value

System.Boolean

true if the producer should enable idempotent partition publishing; otherwise, false. Idempotent partitions are disabled by default.

Identifier

A unique name used to identify the consumer. If null or empty, a GUID will be used as the identifier.

Declaration

public string Identifier { get; set; }

Property Value

System.String

If not specified, a random unique identifier will be generated.

PartitionOptions

The set of options that can be specified to influence publishing behavior specific to the configured Event Hub partition. These options are not necessary in the majority of scenarios and are intended for use with specialized scenarios, such as when recovering the state used for idempotent publishing.

It is highly recommended that these options only be specified if there is a proven need to do so; Incorrectly configuring these values may result in an EventHubProducerClient instance that is unable to publish to the Event Hubs.

Declaration

[System.ComponentModel.EditorBrowsable]
protected internal System.Collections.Generic.Dictionary<string,Azure.Messaging.EventHubs.Producer.PartitionPublishingOptions> PartitionOptions { get; }

Property Value

System.Collections.Generic.Dictionary<System.String,PartitionPublishingOptions>

The default partition options are an empty set.

Remarks

These options are ignored when publishing to the Event Hubs gateway for automatic routing or when using a partition key.

RetryOptions

The set of options to use for determining whether a failed operation should be retried and, if so, the amount of time to wait between retry attempts. These options also control the amount of time allowed for publishing events and other interactions with the Event Hubs service.

Declaration

public Azure.Messaging.EventHubs.EventHubsRetryOptions RetryOptions { get; set; }

Property Value

EventHubsRetryOptions

Methods

Equals(Object)

Determines whether the specified System.Object is equal to this instance.

Declaration

[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);

Parameters

System.Object obj

The System.Object to compare with this instance.

Returns

System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

Declaration

[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();

Returns

System.Int32

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

ToString()

Converts the instance to string representation.

Declaration

[System.ComponentModel.EditorBrowsable]
public override string ToString ();

Returns

System.String

A System.String that represents this instance.