io.warp10.continuum.store.thrift.data

Enum FetchRequest._Fields

java.lang.Object

java.lang.Enum<FetchRequest._Fields>

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

All Implemented Interfaces:

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

Enclosing class:

FetchRequest

public static enum FetchRequest._Fields
extends java.lang.Enum<FetchRequest._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
ATTRIBUTES Map of attributes.
COUNT Number of data points to fetch.
METADATAS List of Metadata describing the Geo Time Series to fetch
NOW End timestamp (included)
PARALLEL_SCANNERS Flag indicating whether or not to use parallel scanners if available.
POST_BOUNDARY Size of the post boundary in number of data points.
PRE_BOUNDARY Size of the pre boundary in number of data points.
SAMPLE Sampling rate.
SKIP Number of data points to skip before starting to return values.
STEP Index offset between two data points, defaults to 1, i.e.
THENTS Start timestamp (included).
TIMESTEP Minimum time offset between data points, expressed in time units.
TOKEN Read token to use for fetching data
TTL Flag indicating we want to return the HBase cells TTL instead of the value This only works if the HBase client is configured with: hbase.client.rpc.codec = org.apache.hadoop.hbase.codec.KeyValueCodecWithTags This can be achieved in Warp 10 using the following egress config: egress.hbase.config = hbase.client.rpc.codec egress.hbase.client.rpc.codec = org.apache.hadoop.hbase.codec.KeyValueCodecWithTags Beware that changing the RPC Codec will change it for all calls to HBase, meaning that tags will be transfered between the RegionServer and the Client for each cell, even if there is no interest in the tags.
WRITE_TIMESTAMP Flag indicating to return the HBase cell timestamp instead of the value.

Method Summary

Modifier and Type	Method and Description
static FetchRequest._Fields	findByName(java.lang.String name) Find the _Fields constant that matches name, or null if its not found.
static FetchRequest._Fields	findByThriftId(int fieldId) Find the _Fields constant that matches fieldId, or null if its not found.
static FetchRequest._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 FetchRequest._Fields	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FetchRequest._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

TOKEN

public static final FetchRequest._Fields TOKEN

Read token to use for fetching data

METADATAS

public static final FetchRequest._Fields METADATAS

List of Metadata describing the Geo Time Series to fetch

NOW

public static final FetchRequest._Fields NOW

End timestamp (included)

THENTS

public static final FetchRequest._Fields THENTS

Start timestamp (included). We cannot use 'then' which is a reserved word.

COUNT

public static final FetchRequest._Fields COUNT

Number of data points to fetch. 0 is a valid value if you want to fetch only boundaries. Use -1 to specify you are not fetching by count.

SKIP

public static final FetchRequest._Fields SKIP

Number of data points to skip before starting to return values.

STEP

public static final FetchRequest._Fields STEP

Index offset between two data points, defaults to 1, i.e. return every data point.

TIMESTEP

public static final FetchRequest._Fields TIMESTEP

Minimum time offset between data points, expressed in time units. Defaults to 1.

SAMPLE

public static final FetchRequest._Fields SAMPLE

Sampling rate. Use 1.0D for returning all values. Valid values are ( 0.0D, 1.0D ]

WRITE_TIMESTAMP

public static final FetchRequest._Fields WRITE_TIMESTAMP

Flag indicating to return the HBase cell timestamp instead of the value.

PRE_BOUNDARY

public static final FetchRequest._Fields PRE_BOUNDARY

Size of the pre boundary in number of data points.

POST_BOUNDARY

public static final FetchRequest._Fields POST_BOUNDARY

Size of the post boundary in number of data points.

TTL

public static final FetchRequest._Fields TTL

Flag indicating we want to return the HBase cells TTL instead of the value This only works if the HBase client is configured with: hbase.client.rpc.codec = org.apache.hadoop.hbase.codec.KeyValueCodecWithTags This can be achieved in Warp 10 using the following egress config: egress.hbase.config = hbase.client.rpc.codec egress.hbase.client.rpc.codec = org.apache.hadoop.hbase.codec.KeyValueCodecWithTags Beware that changing the RPC Codec will change it for all calls to HBase, meaning that tags will be transfered between the RegionServer and the Client for each cell, even if there is no interest in the tags. Overall performance may therefore degrade.

PARALLEL_SCANNERS

public static final FetchRequest._Fields PARALLEL_SCANNERS

Flag indicating whether or not to use parallel scanners if available. This may be needed when the order of the returned GTS is important. Performing parallel scans will mix the results of all of them thus altering the order of the original GTS list.

ATTRIBUTES

public static final FetchRequest._Fields ATTRIBUTES

Map of attributes. This is used to pass information between client and backend if needed.

Method Detail

values

public static FetchRequest._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 (FetchRequest._Fields c : FetchRequest._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 FetchRequest._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 FetchRequest._Fields findByThriftId(int fieldId)

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

findByThriftIdOrThrow

public static FetchRequest._Fields findByThriftIdOrThrow(int fieldId)

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

findByName

public static FetchRequest._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