Class ConsumerConfigurationsOptions

Configurations for a Eventhub consumer that will make messages as read.

Inheritance

System.Object

ConsumerConfigurationsOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: StoneCo.Framework.EventHub.Options

Assembly: cs.temp.dll.dll

Syntax

public class ConsumerConfigurationsOptions

Properties

ConnectionString

Azure Event Hub connection string format.

Used to Send events, required if used to producer events.

Declaration

public string ConnectionString { get; set; }

Property Value

Type	Description
System.String	Endpoint=sb://sample-eventhub.servicebus.windows.net/;SharedAccessKeyName=SampleProducer;SharedAccessKey=XxxnXxxxXXsnnxxxxxXxxXXxxxnXXxXXnxxXxnxXxxn=

ConsumeDelayInSeconds

In seconds, messages that will be read, since current datetime less this delay.

Used to Receive events; not required; default value is 7200.

Declaration

public int? ConsumeDelayInSeconds { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Null, positive interger numbers.

ConsumerGroupName

Name of group that will use to read partitions. If its not defined, default group will be assumed.

Used to Receive events, optional.

Declaration

public string ConsumerGroupName { get; set; }

Property Value

Type	Description
System.String	consumer-group

EventHubName

Topic name of Azure Event Hub service(Queue).

Declaration

public string EventHubName { get; set; }

Property Value

Type	Description
System.String	queue_or_topic_name_with_sufix

LeaseDurationInSeconds

In seconds, Interval configuration for which the lease is taken on Azure Blob representing an EventHub partition.

Used to Receive events; not required; default value is 60.

Declaration

public int LeaseDurationInSeconds { get; set; }

Property Value

Type	Description
System.Int32	Positive interger numbers more than zero.

Name

The logical name of the event hub client.

This name cannot be repeated also between Consumer and Producer options.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	MyEventHub, MyClient, ...

NumberOfEventsPerRequest

Number of messages that will be read.

Used to Receive events; not required; default value is 1.

Declaration

public int NumberOfEventsPerRequest { get; set; }

Property Value

Type	Description
System.Int32	Positive interger numbers more than zero.

OffsetStartDateTime

Date and Time that will be use as refence to get an start offset.

Used to Receive events; not required; default value is "".

Declaration

public string OffsetStartDateTime { get; set; }

Property Value

Type	Description
System.String	Positive interger numbers more than zero.

ProducerName

The logical name of the event hub client.

Not Required. If it is not set, if returns false or true, application will go offset ahead.

This name should be registered on Producer options.

Declaration

public string ProducerName { get; set; }

Property Value

Type	Description
System.String	MyEventHub, MyClient, ...

ReceiveTimeoutInSeconds

In seconds, Interval configuration for which the timeout length for receive operations.

Used to Receive events; not required; default value is 60.

Declaration

public int ReceiveTimeoutInSeconds { get; set; }

Property Value

Type	Description
System.Int32	Positive interger numbers more than zero.

RenewIntervalInSeconds

In seconds, Renew interval configuration for all leases for partitions currently held by Microsoft.Azure.EventHubs.Processor.EventProcessorHost instance.

Used to Receive events; not required; default value is 10.

Declaration

public int RenewIntervalInSeconds { get; set; }

Property Value

Type	Description
System.Int32	Positive interger numbers more than zero.

Shunt

Configurations for a Shunt, when a error occurrs over and over again.

Not Required. If it is not set, if returns false or true, application will go offset ahead.

Declaration

public ShuntOptions Shunt { get; set; }

Property Value

Type	Description
ShuntOptions	Is a Required object.

StorageAccountKey

Access key of credential that will access container storage.

Used to Receive events.

Declaration

public string StorageAccountKey { get; set; }

Property Value

Type	Description
System.String	XxXnxxXXnXXsxXxXnxxXnnXnXxXxXxxXXXsnXXnXXXnxXXxXxxnxXnnnxnxxxXnXsnxnXxxnxnxXXXsxXxnxxx==

StorageAccountName

Name of credential that will access container storage.

Used to Receive events.

Declaration

public string StorageAccountName { get; set; }

Property Value

Type	Description
System.String	Sample: acquirerflow

StorageContainerName

Container that store offset registers.

Used to Receive events.

Declaration

public string StorageContainerName { get; set; }

Property Value

Type	Description
System.String	something-with-sufix-offset