com.microsoft.azure.sdk.iot.device

Enum IotHubMessageResult

java.lang.Object

java.lang.Enum<IotHubMessageResult>

com.microsoft.azure.sdk.iot.device.IotHubMessageResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IotHubMessageResult>

public enum IotHubMessageResult
extends java.lang.Enum<IotHubMessageResult>

A return value from a message callback that instructs an IoT hub to complete, abandon, or reject the message. These states are only valid for AMQP messages.

See The cloud-to-device message life cycle for more details on the states and what it means for message delivery and retry.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABANDON Instructs IoT hub to abandon the message.
COMPLETE Instructs IoT hub to complete the message.
REJECT Instructs IoT hub to reject the message.

Method Summary

Modifier and Type	Method and Description
static IotHubMessageResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IotHubMessageResult[]	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

COMPLETE

public static final IotHubMessageResult COMPLETE

Instructs IoT hub to complete the message.

This will remove it from the IoT hub messaging queue and set the message to the Completed state.

ABANDON

public static final IotHubMessageResult ABANDON

Instructs IoT hub to abandon the message.

This will put the message back into the IoT hub messaging queue to be processed again. The message will be enqueued back to the IoT hub messaging queue for the value specified for "Max Delivery Count" times. After the max is reached, the message will be set to to the dead lettered state and removed.

REJECT

public static final IotHubMessageResult REJECT

Instructs IoT hub to reject the message.

This will remove the message from the IoT hub messaging queue and sets the message to the dead lettered state.

Method Detail

values

public static IotHubMessageResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IotHubMessageResult c : IotHubMessageResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static IotHubMessageResult valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null