Package com.azure.messaging.servicebus.models

Enum ServiceBusMessageState

java.lang.Object

java.lang.Enum<ServiceBusMessageState>

com.azure.messaging.servicebus.models.ServiceBusMessageState

All Implemented Interfaces:

Serializable, Comparable<ServiceBusMessageState>, java.lang.constant.Constable

public enum ServiceBusMessageState
extends Enum<ServiceBusMessageState>

Represents the message state of the ServiceBusReceivedMessage.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Specifies an active message state.
DEFERRED	Specifies a deferred message state.
SCHEDULED	Specifies a scheduled message state.

Method Summary

Modifier and Type	Method	Description
static ServiceBusMessageState	fromValue(int value)	Gets the message state from value.
int	getValue()	Gets the value of the message state.
static ServiceBusMessageState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ServiceBusMessageState[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ACTIVE

public static final ServiceBusMessageState ACTIVE

Specifies an active message state.

DEFERRED

public static final ServiceBusMessageState DEFERRED

Specifies a deferred message state.

SCHEDULED

public static final ServiceBusMessageState SCHEDULED

Specifies a scheduled message state.

Method Details

values

public static ServiceBusMessageState[] values()

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

Returns:

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

valueOf

public static ServiceBusMessageState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

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

getValue

public int getValue()

Gets the value of the message state.

Returns:

The value of the message state.

fromValue

public static ServiceBusMessageState fromValue(int value)

Gets the message state from value.

Parameters:

value - Integer value of the message state.

Returns:

The corresponding message state.

Throws:

UnsupportedOperationException - if value is not a known message state.