com.microsoft.azure.functions.annotation

Enum Cardinality

java.lang.Object

java.lang.Enum<Cardinality>

com.microsoft.azure.functions.annotation.Cardinality

All Implemented Interfaces:

Serializable, Comparable<Cardinality>

public enum Cardinality
extends Enum<Cardinality>

Cardinality of the EventHubTrigger input. Choose 'ONE' if the input is a single message or 'Many' if the input is an array of messages. 'Many' is the default if unspecified

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANY To receive events in a batch, set cardinality to MANY.
ONE To receive a single message, set cardinality to ONE

Method Summary

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

ONE

public static final Cardinality ONE

To receive a single message, set cardinality to ONE

MANY

public static final Cardinality MANY

To receive events in a batch, set cardinality to MANY. This is the default if omitted.

Method Detail

values

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

Returns:

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

valueOf

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