com.microsoft.azure.sdk.iot.service.messaging

Enum AcknowledgementType

java.lang.Object

java.lang.Enum<AcknowledgementType>

com.microsoft.azure.sdk.iot.service.messaging.AcknowledgementType

All Implemented Interfaces:

Serializable, Comparable<AcknowledgementType>

public enum AcknowledgementType
extends Enum<AcknowledgementType>

The possible acknowledgement types for a received file upload notification and/or for a received cloud to device feedback message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABANDON This acknowledgement will requeue the received message back into the service's message queue so that it will be sent again.
COMPLETE This acknowledgement will remove the received message from the service's message queue so that it won't be sent again.

Method Summary

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

This acknowledgement will remove the received message from the service's message queue so that it won't be sent again.

ABANDON

public static final AcknowledgementType ABANDON

This acknowledgement will requeue the received message back into the service's message queue so that it will be sent again. This may be done if the message in question should be received by a different receiver, or at a later time. Each service message has a finite number of times that it can be received and then abandoned before the message will be removed from the queue. This maximum number of times it can be received can be set through the Azure portal.

Method Detail

values

public static AcknowledgementType[] 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 (AcknowledgementType c : AcknowledgementType.values())
    System.out.println(c);

Returns:

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

valueOf

public static AcknowledgementType 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