Package com.qtsurfer.api.sdk

Enum Class Sweep.State

java.lang.Object

java.lang.Enum<Sweep.State>

com.qtsurfer.api.sdk.Sweep.State

All Implemented Interfaces:

Serializable, Comparable<Sweep.State>, Constable

Enclosing class:

Sweep

public static enum Sweep.State
extends Enum<Sweep.State>

Sweep lifecycle as observed by the SDK.

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
CANCELED	The platform reported the sweep as cancelled.
COMPLETED	Finished.
EXECUTING	Submitted and being polled.
FAILED	The poll itself failed — transport, HTTP, or a stage timeout.

Method Summary

Modifier and Type	Method	Description
static Sweep.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Sweep.State[]	values()	Returns an array containing the constants of this enum class, 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

EXECUTING

public static final Sweep.State EXECUTING

Submitted and being polled.

COMPLETED

public static final Sweep.State COMPLETED

Finished. The platform's own status may still be PARTIAL.

FAILED

public static final Sweep.State FAILED

The poll itself failed — transport, HTTP, or a stage timeout.

CANCELED

public static final Sweep.State CANCELED

The platform reported the sweep as cancelled.

Method Details

values

public static Sweep.State[] values()

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

Returns:

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

valueOf

public static Sweep.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null