com.azure.messaging.eventhubs.models

Enum CloseReason

java.lang.Object

java.lang.Enum<CloseReason>

com.azure.messaging.eventhubs.models.CloseReason

All Implemented Interfaces:

Serializable, Comparable<CloseReason>

public enum CloseReason
extends Enum<CloseReason>

Enumeration of all possible reasons a PartitionProcessor may be closed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENT_HUB_EXCEPTION If a non-retryable exception occured when receiving events from Event Hub, this reason will be provided when PartitionProcessor.close(CloseContext) is called.
EVENT_PROCESSOR_SHUTDOWN If the event processor is shutting down by calling EventProcessorClient.stop(), the PartitionProcessor.close(CloseContext) will be called with this reason.
LOST_PARTITION_OWNERSHIP If another event processor instance stole the ownership of a partition, this reason will be provided to PartitionProcessor.close(CloseContext).

Method Summary

Modifier and Type	Method and Description
static CloseReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static CloseReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOST_PARTITION_OWNERSHIP

public static final CloseReason LOST_PARTITION_OWNERSHIP

If another event processor instance stole the ownership of a partition, this reason will be provided to PartitionProcessor.close(CloseContext).

EVENT_PROCESSOR_SHUTDOWN

public static final CloseReason EVENT_PROCESSOR_SHUTDOWN

If the event processor is shutting down by calling EventProcessorClient.stop(), the PartitionProcessor.close(CloseContext) will be called with this reason.

EVENT_HUB_EXCEPTION

public static final CloseReason EVENT_HUB_EXCEPTION

If a non-retryable exception occured when receiving events from Event Hub, this reason will be provided when PartitionProcessor.close(CloseContext) is called.

Method Detail

values

public static CloseReason[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CloseReason valueOf(String name)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null