Show / Hide Table of Contents

Class EventHubConsumerClientOptions

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

Inheritance
System.Object
EventHubConsumerClientOptions
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Messaging.EventHubs.dll
Syntax
public class EventHubConsumerClientOptions

Constructors

EventHubConsumerClientOptions()

Declaration
public EventHubConsumerClientOptions ();

Properties

ConnectionOptions

The options used for configuring the connection to the Event Hubs service.

Declaration
public Azure.Messaging.EventHubs.EventHubConnectionOptions ConnectionOptions { get; set; }
Property Value
EventHubConnectionOptions

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.

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 reading 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.

Back to top Azure SDK for .NET