FetchRequest (warpscript 3.0.0-beta0 API)

java.lang.Object
- io.warp10.continuum.store.thrift.data.FetchRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<FetchRequest>, org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>, org.apache.thrift.TSerializable
```
public class FetchRequest
extends java.lang.Object
implements org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<FetchRequest>
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FetchRequest._Fields` The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Field Summary

Fields
Modifier and Type Field and Description

static java.util.Map<FetchRequest._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

Fields
Modifier and Type	Field and Description
`static java.util.Map<FetchRequest._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`

Constructor Summary

Constructors
Constructor and Description

FetchRequest()

FetchRequest(FetchRequest other)
Performs a deep copy on other.

Constructors
Constructor and Description
`FetchRequest()`
`FetchRequest(FetchRequest other)` Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToMetadatas(Metadata elem)`
`void`	`clear()`
`int`	`compareTo(FetchRequest other)`
`FetchRequest`	`deepCopy()`
`boolean`	`equals(FetchRequest that)`
`boolean`	`equals(java.lang.Object that)`
`FetchRequest._Fields`	`fieldForId(int fieldId)`
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Map of attributes.
`int`	`getAttributesSize()`
`long`	`getCount()` Number of data points to fetch.
`java.lang.Object`	`getFieldValue(FetchRequest._Fields field)`
`java.util.List<Metadata>`	`getMetadatas()` List of Metadata describing the Geo Time Series to fetch
`java.util.Iterator<Metadata>`	`getMetadatasIterator()`
`int`	`getMetadatasSize()`
`long`	`getNow()` End timestamp (included)
`long`	`getPostBoundary()` Size of the post boundary in number of data points.
`long`	`getPreBoundary()` Size of the pre boundary in number of data points.
`double`	`getSample()` Sampling rate.
`long`	`getSkip()` Number of data points to skip before starting to return values.
`long`	`getStep()` Index offset between two data points, defaults to 1, i.e.
`long`	`getThents()` Start timestamp (included).
`long`	`getTimestep()` Minimum time offset between data points, expressed in time units.
`ReadToken`	`getToken()` Read token to use for fetching data
`int`	`hashCode()`
`boolean`	`isParallelScanners()` Flag indicating whether or not to use parallel scanners if available.
`boolean`	`isSet(FetchRequest._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAttributes()` Returns true if field attributes is set (has been assigned a value) and false otherwise
`boolean`	`isSetCount()` Returns true if field count is set (has been assigned a value) and false otherwise
`boolean`	`isSetMetadatas()` Returns true if field metadatas is set (has been assigned a value) and false otherwise
`boolean`	`isSetNow()` Returns true if field now is set (has been assigned a value) and false otherwise
`boolean`	`isSetParallelScanners()` Returns true if field parallelScanners is set (has been assigned a value) and false otherwise
`boolean`	`isSetPostBoundary()` Returns true if field postBoundary is set (has been assigned a value) and false otherwise
`boolean`	`isSetPreBoundary()` Returns true if field preBoundary is set (has been assigned a value) and false otherwise
`boolean`	`isSetSample()` Returns true if field sample is set (has been assigned a value) and false otherwise
`boolean`	`isSetSkip()` Returns true if field skip is set (has been assigned a value) and false otherwise
`boolean`	`isSetStep()` Returns true if field step is set (has been assigned a value) and false otherwise
`boolean`	`isSetThents()` Returns true if field thents is set (has been assigned a value) and false otherwise
`boolean`	`isSetTimestep()` Returns true if field timestep is set (has been assigned a value) and false otherwise
`boolean`	`isSetToken()` Returns true if field token is set (has been assigned a value) and false otherwise
`void`	`putToAttributes(java.lang.String key, java.lang.String val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`FetchRequest`	`setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)` Map of attributes.
`void`	`setAttributesIsSet(boolean value)`
`FetchRequest`	`setCount(long count)` Number of data points to fetch.
`void`	`setCountIsSet(boolean value)`
`void`	`setFieldValue(FetchRequest._Fields field, java.lang.Object value)`
`FetchRequest`	`setMetadatas(java.util.List<Metadata> metadatas)` List of Metadata describing the Geo Time Series to fetch
`void`	`setMetadatasIsSet(boolean value)`
`FetchRequest`	`setNow(long now)` End timestamp (included)
`void`	`setNowIsSet(boolean value)`
`FetchRequest`	`setParallelScanners(boolean parallelScanners)` Flag indicating whether or not to use parallel scanners if available.
`void`	`setParallelScannersIsSet(boolean value)`
`FetchRequest`	`setPostBoundary(long postBoundary)` Size of the post boundary in number of data points.
`void`	`setPostBoundaryIsSet(boolean value)`
`FetchRequest`	`setPreBoundary(long preBoundary)` Size of the pre boundary in number of data points.
`void`	`setPreBoundaryIsSet(boolean value)`
`FetchRequest`	`setSample(double sample)` Sampling rate.
`void`	`setSampleIsSet(boolean value)`
`FetchRequest`	`setSkip(long skip)` Number of data points to skip before starting to return values.
`void`	`setSkipIsSet(boolean value)`
`FetchRequest`	`setStep(long step)` Index offset between two data points, defaults to 1, i.e.
`void`	`setStepIsSet(boolean value)`
`FetchRequest`	`setThents(long thents)` Start timestamp (included).
`void`	`setThentsIsSet(boolean value)`
`FetchRequest`	`setTimestep(long timestep)` Minimum time offset between data points, expressed in time units.
`void`	`setTimestepIsSet(boolean value)`
`FetchRequest`	`setToken(ReadToken token)` Read token to use for fetching data
`void`	`setTokenIsSet(boolean value)`
`java.lang.String`	`toString()`
`void`	`unsetAttributes()`
`void`	`unsetCount()`
`void`	`unsetMetadatas()`
`void`	`unsetNow()`
`void`	`unsetParallelScanners()`
`void`	`unsetPostBoundary()`
`void`	`unsetPreBoundary()`
`void`	`unsetSample()`
`void`	`unsetSkip()`
`void`	`unsetStep()`
`void`	`unsetThents()`
`void`	`unsetTimestep()`
`void`	`unsetToken()`
`void`	`validate()`
`void`	`write(org.apache.thrift.protocol.TProtocol oprot)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - metaDataMap
```
public static final java.util.Map<FetchRequest._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap
```
- Constructor Detail
  - FetchRequest
```
public FetchRequest()
```
  - FetchRequest
```
public FetchRequest(FetchRequest other)
```
    Performs a deep copy on other.
- Method Detail
  - deepCopy
```
public FetchRequest deepCopy()
```
    Specified by:
    
    deepCopy in interface org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>
  - getToken
```
public ReadToken getToken()
```
    Read token to use for fetching data
  - setToken
```
public FetchRequest setToken(ReadToken token)
```
    Read token to use for fetching data
  - unsetToken
```
public void unsetToken()
```
  - isSetToken
```
public boolean isSetToken()
```
    Returns true if field token is set (has been assigned a value) and false otherwise
  - setTokenIsSet
```
public void setTokenIsSet(boolean value)
```
  - getMetadatasSize
```
public int getMetadatasSize()
```
  - getMetadatasIterator
```
public java.util.Iterator<Metadata> getMetadatasIterator()
```
  - addToMetadatas
```
public void addToMetadatas(Metadata elem)
```
  - getMetadatas
```
public java.util.List<Metadata> getMetadatas()
```
    List of Metadata describing the Geo Time Series to fetch
  - setMetadatas
```
public FetchRequest setMetadatas(java.util.List<Metadata> metadatas)
```
    List of Metadata describing the Geo Time Series to fetch
  - unsetMetadatas
```
public void unsetMetadatas()
```
  - isSetMetadatas
```
public boolean isSetMetadatas()
```
    Returns true if field metadatas is set (has been assigned a value) and false otherwise
  - setMetadatasIsSet
```
public void setMetadatasIsSet(boolean value)
```
  - getNow
```
public long getNow()
```
    End timestamp (included)
  - setNow
```
public FetchRequest setNow(long now)
```
    End timestamp (included)
  - unsetNow
```
public void unsetNow()
```
  - isSetNow
```
public boolean isSetNow()
```
    Returns true if field now is set (has been assigned a value) and false otherwise
  - setNowIsSet
```
public void setNowIsSet(boolean value)
```
  - getThents
```
public long getThents()
```
    Start timestamp (included). We cannot use 'then' which is a reserved word.
  - setThents
```
public FetchRequest setThents(long thents)
```
    Start timestamp (included). We cannot use 'then' which is a reserved word.
  - unsetThents
```
public void unsetThents()
```
  - isSetThents
```
public boolean isSetThents()
```
    Returns true if field thents is set (has been assigned a value) and false otherwise
  - setThentsIsSet
```
public void setThentsIsSet(boolean value)
```
  - getCount
```
public long getCount()
```
    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.
  - setCount
```
public FetchRequest setCount(long 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.
  - unsetCount
```
public void unsetCount()
```
  - isSetCount
```
public boolean isSetCount()
```
    Returns true if field count is set (has been assigned a value) and false otherwise
  - setCountIsSet
```
public void setCountIsSet(boolean value)
```
  - getSkip
```
public long getSkip()
```
    Number of data points to skip before starting to return values.
  - setSkip
```
public FetchRequest setSkip(long skip)
```
    Number of data points to skip before starting to return values.
  - unsetSkip
```
public void unsetSkip()
```
  - isSetSkip
```
public boolean isSetSkip()
```
    Returns true if field skip is set (has been assigned a value) and false otherwise
  - setSkipIsSet
```
public void setSkipIsSet(boolean value)
```
  - getStep
```
public long getStep()
```
    Index offset between two data points, defaults to 1, i.e. return every data point.
  - setStep
```
public FetchRequest setStep(long step)
```
    Index offset between two data points, defaults to 1, i.e. return every data point.
  - unsetStep
```
public void unsetStep()
```
  - isSetStep
```
public boolean isSetStep()
```
    Returns true if field step is set (has been assigned a value) and false otherwise
  - setStepIsSet
```
public void setStepIsSet(boolean value)
```
  - getTimestep
```
public long getTimestep()
```
    Minimum time offset between data points, expressed in time units. Defaults to 1.
  - setTimestep
```
public FetchRequest setTimestep(long timestep)
```
    Minimum time offset between data points, expressed in time units. Defaults to 1.
  - unsetTimestep
```
public void unsetTimestep()
```
  - isSetTimestep
```
public boolean isSetTimestep()
```
    Returns true if field timestep is set (has been assigned a value) and false otherwise
  - setTimestepIsSet
```
public void setTimestepIsSet(boolean value)
```
  - getSample
```
public double getSample()
```
    Sampling rate. Use 1.0D for returning all values. Valid values are ( 0.0D, 1.0D ]
  - setSample
```
public FetchRequest setSample(double sample)
```
    Sampling rate. Use 1.0D for returning all values. Valid values are ( 0.0D, 1.0D ]
  - unsetSample
```
public void unsetSample()
```
  - isSetSample
```
public boolean isSetSample()
```
    Returns true if field sample is set (has been assigned a value) and false otherwise
  - setSampleIsSet
```
public void setSampleIsSet(boolean value)
```
  - getPreBoundary
```
public long getPreBoundary()
```
    Size of the pre boundary in number of data points.
  - setPreBoundary
```
public FetchRequest setPreBoundary(long preBoundary)
```
    Size of the pre boundary in number of data points.
  - unsetPreBoundary
```
public void unsetPreBoundary()
```
  - isSetPreBoundary
```
public boolean isSetPreBoundary()
```
    Returns true if field preBoundary is set (has been assigned a value) and false otherwise
  - setPreBoundaryIsSet
```
public void setPreBoundaryIsSet(boolean value)
```
  - getPostBoundary
```
public long getPostBoundary()
```
    Size of the post boundary in number of data points.
  - setPostBoundary
```
public FetchRequest setPostBoundary(long postBoundary)
```
    Size of the post boundary in number of data points.
  - unsetPostBoundary
```
public void unsetPostBoundary()
```
  - isSetPostBoundary
```
public boolean isSetPostBoundary()
```
    Returns true if field postBoundary is set (has been assigned a value) and false otherwise
  - setPostBoundaryIsSet
```
public void setPostBoundaryIsSet(boolean value)
```
  - isParallelScanners
```
public boolean isParallelScanners()
```
    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.
  - setParallelScanners
```
public FetchRequest setParallelScanners(boolean parallelScanners)
```
    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.
  - unsetParallelScanners
```
public void unsetParallelScanners()
```
  - isSetParallelScanners
```
public boolean isSetParallelScanners()
```
    Returns true if field parallelScanners is set (has been assigned a value) and false otherwise
  - setParallelScannersIsSet
```
public void setParallelScannersIsSet(boolean value)
```
  - getAttributesSize
```
public int getAttributesSize()
```
  - putToAttributes
```
public void putToAttributes(java.lang.String key,
                            java.lang.String val)
```
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
```
    Map of attributes. This is used to pass information between client and backend if needed.
  - setAttributes
```
public FetchRequest setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Map of attributes. This is used to pass information between client and backend if needed.
  - unsetAttributes
```
public void unsetAttributes()
```
  - isSetAttributes
```
public boolean isSetAttributes()
```
    Returns true if field attributes is set (has been assigned a value) and false otherwise
  - setAttributesIsSet
```
public void setAttributesIsSet(boolean value)
```
  - setFieldValue
```
public void setFieldValue(FetchRequest._Fields field,
                          java.lang.Object value)
```
    Specified by:
    
    setFieldValue in interface org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>
  - getFieldValue
```
public java.lang.Object getFieldValue(FetchRequest._Fields field)
```
    Specified by:
    
    getFieldValue in interface org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>
  - isSet
```
public boolean isSet(FetchRequest._Fields field)
```
    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
    
    Specified by:
    
    isSet in interface org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>
  - equals
```
public boolean equals(java.lang.Object that)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(FetchRequest that)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - compareTo
```
public int compareTo(FetchRequest other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<FetchRequest>
  - fieldForId
```
public FetchRequest._Fields fieldForId(int fieldId)
```
    Specified by:
    
    fieldForId in interface org.apache.thrift.TBase<FetchRequest,FetchRequest._Fields>
  - read
```
public void read(org.apache.thrift.protocol.TProtocol iprot)
          throws org.apache.thrift.TException
```
    Specified by:
    
    read in interface org.apache.thrift.TSerializable
    
    Throws:
    
    org.apache.thrift.TException
  - write
```
public void write(org.apache.thrift.protocol.TProtocol oprot)
           throws org.apache.thrift.TException
```
    Specified by:
    
    write in interface org.apache.thrift.TSerializable
    
    Throws:
    
    org.apache.thrift.TException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - validate
```
public void validate()
              throws org.apache.thrift.TException
```
    Throws:
    
    org.apache.thrift.TException

Class FetchRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaDataMap

Constructor Detail

FetchRequest

FetchRequest

Method Detail

deepCopy

clear

getToken

setToken

unsetToken

isSetToken

setTokenIsSet

getMetadatasSize

getMetadatasIterator

addToMetadatas

getMetadatas

setMetadatas

unsetMetadatas

isSetMetadatas

setMetadatasIsSet

getNow

setNow

unsetNow

isSetNow

setNowIsSet

getThents

setThents

unsetThents

isSetThents

setThentsIsSet

getCount

setCount

unsetCount

isSetCount

setCountIsSet

getSkip

setSkip

unsetSkip

isSetSkip

setSkipIsSet

getStep

setStep

unsetStep

isSetStep

setStepIsSet

getTimestep

setTimestep

unsetTimestep

isSetTimestep

setTimestepIsSet

getSample

setSample

unsetSample

isSetSample

setSampleIsSet

getPreBoundary

setPreBoundary

unsetPreBoundary

isSetPreBoundary

setPreBoundaryIsSet

getPostBoundary

setPostBoundary

unsetPostBoundary

isSetPostBoundary

setPostBoundaryIsSet

isParallelScanners

setParallelScanners

unsetParallelScanners

isSetParallelScanners

setParallelScannersIsSet

getAttributesSize

putToAttributes

getAttributes