io.warp10.continuum.store.thrift.data

Enum MetaSet._Fields

java.lang.Object

java.lang.Enum<MetaSet._Fields>

io.warp10.continuum.store.thrift.data.MetaSet._Fields

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetaSet._Fields>, org.apache.thrift.TFieldIdEnum

Enclosing class:

MetaSet

public static enum MetaSet._Fields
extends java.lang.Enum<MetaSet._Fields>
implements org.apache.thrift.TFieldIdEnum

The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPIRY Timestamp (in ms since epoch) at which the MetaSet expires.
MAXDURATION Maximum duration this MetaSet can be used with.
METADATAS List of Metadata in this MetaSet.
NOTAFTER If this field is set, maxduration will still be considered, unless notbefore is also set, but the end timestamp will be constraint to be <= notafter.
NOTBEFORE If this field is set, maxduration will be ignored and count based requests will be forbidden.
TOKEN The original token used to construct the MetaSet.

Method Summary

Modifier and Type	Method and Description
static MetaSet._Fields	findByName(java.lang.String name) Find the _Fields constant that matches name, or null if its not found.
static MetaSet._Fields	findByThriftId(int fieldId) Find the _Fields constant that matches fieldId, or null if its not found.
static MetaSet._Fields	findByThriftIdOrThrow(int fieldId) Find the _Fields constant that matches fieldId, throwing an exception if it is not found.
java.lang.String	getFieldName()
short	getThriftFieldId()
static MetaSet._Fields	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MetaSet._Fields[]	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

EXPIRY

public static final MetaSet._Fields EXPIRY

Timestamp (in ms since epoch) at which the MetaSet expires. This is the first field so it also serves as a seed for the encryption.

TOKEN

public static final MetaSet._Fields TOKEN

The original token used to construct the MetaSet. It will be verified when the MetaSet is used.

METADATAS

public static final MetaSet._Fields METADATAS

List of Metadata in this MetaSet.

MAXDURATION

public static final MetaSet._Fields MAXDURATION

Maximum duration this MetaSet can be used with. Setting this field will force the end timestamp to be 'now' and the duration to be <= maxduration if duration (timespan) is >= 0 >= maxduration if timespan < 0

NOTBEFORE

public static final MetaSet._Fields NOTBEFORE

If this field is set, maxduration will be ignored and count based requests will be forbidden. The value of this field (in time units) will constraint the queryable time range.

NOTAFTER

public static final MetaSet._Fields NOTAFTER

If this field is set, maxduration will still be considered, unless notbefore is also set, but the end timestamp will be constraint to be <= notafter.

Method Detail

values

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

Returns:

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

valueOf

public static MetaSet._Fields 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

findByThriftId

public static MetaSet._Fields findByThriftId(int fieldId)

Find the _Fields constant that matches fieldId, or null if its not found.

findByThriftIdOrThrow

public static MetaSet._Fields findByThriftIdOrThrow(int fieldId)

Find the _Fields constant that matches fieldId, throwing an exception if it is not found.

findByName

public static MetaSet._Fields findByName(java.lang.String name)

Find the _Fields constant that matches name, or null if its not found.

getThriftFieldId

public short getThriftFieldId()

Specified by:

getThriftFieldId in interface org.apache.thrift.TFieldIdEnum

getFieldName

public java.lang.String getFieldName()

Specified by:

getFieldName in interface org.apache.thrift.TFieldIdEnum