ReadToken (warpscript 3.0.0-beta1 API)

java.lang.Object
- io.warp10.quasar.token.thrift.data.ReadToken

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ReadToken>, org.apache.thrift.TBase<ReadToken,ReadToken._Fields>, org.apache.thrift.TSerializable
```
public class ReadToken
extends java.lang.Object
implements org.apache.thrift.TBase<ReadToken,ReadToken._Fields>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<ReadToken>
```
The read token contains all the data necessary for remove all data lookup calls. He can be used only for data access

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ReadToken._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<ReadToken._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

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

Constructor Summary

Constructors
Constructor and Description
`ReadToken()`
`ReadToken(long issuanceTimestamp, long expiryTimestamp, TokenType tokenType, java.util.List<java.lang.String> apps, java.util.List<java.nio.ByteBuffer> owners, java.util.List<java.nio.ByteBuffer> producers, java.nio.ByteBuffer billedId)`
`ReadToken(ReadToken other)` Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToApps(java.lang.String elem)`
`void`	`addToOwners(java.nio.ByteBuffer elem)`
`void`	`addToProducers(java.nio.ByteBuffer elem)`
`java.nio.ByteBuffer`	`bufferForBilledId()`
`void`	`clear()`
`int`	`compareTo(ReadToken other)`
`ReadToken`	`deepCopy()`
`boolean`	`equals(java.lang.Object that)`
`boolean`	`equals(ReadToken that)`
`ReadToken._Fields`	`fieldForId(int fieldId)`
`java.lang.String`	`getAppName()` Name of the application using the token
`java.util.List<java.lang.String>`	`getApps()` List of applications consumed
`java.util.Iterator<java.lang.String>`	`getAppsIterator()`
`int`	`getAppsSize()`
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Token attributes
`int`	`getAttributesSize()`
`byte[]`	`getBilledId()` Id of the billed customer
`long`	`getExpiryTimestamp()` Timestamp of the token expiration
`java.lang.Object`	`getFieldValue(ReadToken._Fields field)`
`java.util.Map<java.lang.String,java.lang.String>`	`getHooks()` Token hooks
`int`	`getHooksSize()`
`long`	`getIssuanceTimestamp()` delivery timestamp of the token
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` Token extra labels.
`int`	`getLabelsSize()`
`long`	`getMaxFetchSize()` DEPRECATED Max fetch size in bytes of each read request, default 16Mb
`java.util.List<java.nio.ByteBuffer>`	`getOwners()` List of owners
`java.util.Iterator<java.nio.ByteBuffer>`	`getOwnersIterator()`
`int`	`getOwnersSize()`
`java.util.List<java.nio.ByteBuffer>`	`getProducers()` List of producers
`java.util.Iterator<java.nio.ByteBuffer>`	`getProducersIterator()`
`int`	`getProducersSize()`
`TokenType`	`getTokenType()` TokenType (Set to TokenType.READ)
`int`	`hashCode()`
`boolean`	`isDataviz()` The read token is used for data visualisation, default false
`boolean`	`isGroovy()` DEPRECATED.
`boolean`	`isLookup()` true if a lookup is necessary, default false
`boolean`	`isSet(ReadToken._Fields field)` Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAppName()` Returns true if field appName is set (has been assigned a value) and false otherwise
`boolean`	`isSetApps()` Returns true if field apps 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`	`isSetBilledId()` Returns true if field billedId is set (has been assigned a value) and false otherwise
`boolean`	`isSetDataviz()` Returns true if field dataviz is set (has been assigned a value) and false otherwise
`boolean`	`isSetExpiryTimestamp()` Returns true if field expiryTimestamp is set (has been assigned a value) and false otherwise
`boolean`	`isSetGroovy()` Returns true if field groovy is set (has been assigned a value) and false otherwise
`boolean`	`isSetHooks()` Returns true if field hooks is set (has been assigned a value) and false otherwise
`boolean`	`isSetIssuanceTimestamp()` Returns true if field issuanceTimestamp is set (has been assigned a value) and false otherwise
`boolean`	`isSetLabels()` Returns true if field labels is set (has been assigned a value) and false otherwise
`boolean`	`isSetLookup()` Returns true if field lookup is set (has been assigned a value) and false otherwise
`boolean`	`isSetMaxFetchSize()` Returns true if field maxFetchSize is set (has been assigned a value) and false otherwise
`boolean`	`isSetOwners()` Returns true if field owners is set (has been assigned a value) and false otherwise
`boolean`	`isSetProducers()` Returns true if field producers is set (has been assigned a value) and false otherwise
`boolean`	`isSetTokenType()` Returns true if field tokenType is set (has been assigned a value) and false otherwise
`void`	`putToAttributes(java.lang.String key, java.lang.String val)`
`void`	`putToHooks(java.lang.String key, java.lang.String val)`
`void`	`putToLabels(java.lang.String key, java.lang.String val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`ReadToken`	`setAppName(java.lang.String appName)` Name of the application using the token
`void`	`setAppNameIsSet(boolean value)`
`ReadToken`	`setApps(java.util.List<java.lang.String> apps)` List of applications consumed
`void`	`setAppsIsSet(boolean value)`
`ReadToken`	`setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)` Token attributes
`void`	`setAttributesIsSet(boolean value)`
`ReadToken`	`setBilledId(byte[] billedId)` Id of the billed customer
`ReadToken`	`setBilledId(java.nio.ByteBuffer billedId)`
`void`	`setBilledIdIsSet(boolean value)`
`ReadToken`	`setDataviz(boolean dataviz)` The read token is used for data visualisation, default false
`void`	`setDatavizIsSet(boolean value)`
`ReadToken`	`setExpiryTimestamp(long expiryTimestamp)` Timestamp of the token expiration
`void`	`setExpiryTimestampIsSet(boolean value)`
`void`	`setFieldValue(ReadToken._Fields field, java.lang.Object value)`
`ReadToken`	`setGroovy(boolean groovy)` DEPRECATED.
`void`	`setGroovyIsSet(boolean value)`
`ReadToken`	`setHooks(java.util.Map<java.lang.String,java.lang.String> hooks)` Token hooks
`void`	`setHooksIsSet(boolean value)`
`ReadToken`	`setIssuanceTimestamp(long issuanceTimestamp)` delivery timestamp of the token
`void`	`setIssuanceTimestampIsSet(boolean value)`
`ReadToken`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Token extra labels.
`void`	`setLabelsIsSet(boolean value)`
`ReadToken`	`setLookup(boolean lookup)` true if a lookup is necessary, default false
`void`	`setLookupIsSet(boolean value)`
`ReadToken`	`setMaxFetchSize(long maxFetchSize)` DEPRECATED Max fetch size in bytes of each read request, default 16Mb
`void`	`setMaxFetchSizeIsSet(boolean value)`
`ReadToken`	`setOwners(java.util.List<java.nio.ByteBuffer> owners)` List of owners
`void`	`setOwnersIsSet(boolean value)`
`ReadToken`	`setProducers(java.util.List<java.nio.ByteBuffer> producers)` List of producers
`void`	`setProducersIsSet(boolean value)`
`ReadToken`	`setTokenType(TokenType tokenType)` TokenType (Set to TokenType.READ)
`void`	`setTokenTypeIsSet(boolean value)`
`java.lang.String`	`toString()`
`void`	`unsetAppName()`
`void`	`unsetApps()`
`void`	`unsetAttributes()`
`void`	`unsetBilledId()`
`void`	`unsetDataviz()`
`void`	`unsetExpiryTimestamp()`
`void`	`unsetGroovy()`
`void`	`unsetHooks()`
`void`	`unsetIssuanceTimestamp()`
`void`	`unsetLabels()`
`void`	`unsetLookup()`
`void`	`unsetMaxFetchSize()`
`void`	`unsetOwners()`
`void`	`unsetProducers()`
`void`	`unsetTokenType()`
`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<ReadToken._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

Constructor Detail

ReadToken
```
public ReadToken()
```

ReadToken

public ReadToken(long issuanceTimestamp,
                 long expiryTimestamp,
                 TokenType tokenType,
                 java.util.List<java.lang.String> apps,
                 java.util.List<java.nio.ByteBuffer> owners,
                 java.util.List<java.nio.ByteBuffer> producers,
                 java.nio.ByteBuffer billedId)

ReadToken
```
public ReadToken(ReadToken other)
```
Performs a deep copy on other.

Method Detail

deepCopy
```
public ReadToken deepCopy()
```
Specified by:

deepCopy in interface org.apache.thrift.TBase<ReadToken,ReadToken._Fields>

clear
```
public void clear()
```
Specified by:

clear in interface org.apache.thrift.TBase<ReadToken,ReadToken._Fields>

getIssuanceTimestamp
```
public long getIssuanceTimestamp()
```
delivery timestamp of the token

setIssuanceTimestamp

public ReadToken setIssuanceTimestamp(long issuanceTimestamp)

delivery timestamp of the token

unsetIssuanceTimestamp
```
public void unsetIssuanceTimestamp()
```

isSetIssuanceTimestamp
```
public boolean isSetIssuanceTimestamp()
```
Returns true if field issuanceTimestamp is set (has been assigned a value) and false otherwise

setIssuanceTimestampIsSet

public void setIssuanceTimestampIsSet(boolean value)

getExpiryTimestamp
```
public long getExpiryTimestamp()
```
Timestamp of the token expiration

setExpiryTimestamp

public ReadToken setExpiryTimestamp(long expiryTimestamp)

Timestamp of the token expiration

unsetExpiryTimestamp
```
public void unsetExpiryTimestamp()
```

isSetExpiryTimestamp
```
public boolean isSetExpiryTimestamp()
```
Returns true if field expiryTimestamp is set (has been assigned a value) and false otherwise

setExpiryTimestampIsSet

public void setExpiryTimestampIsSet(boolean value)

getTokenType
```
public TokenType getTokenType()
```
TokenType (Set to TokenType.READ)

See Also:

TokenType

setTokenType
```
public ReadToken setTokenType(TokenType tokenType)
```
TokenType (Set to TokenType.READ)

See Also:

TokenType

unsetTokenType
```
public void unsetTokenType()
```

isSetTokenType
```
public boolean isSetTokenType()
```
Returns true if field tokenType is set (has been assigned a value) and false otherwise

setTokenTypeIsSet

public void setTokenTypeIsSet(boolean value)

isLookup
```
public boolean isLookup()
```
true if a lookup is necessary, default false

setLookup
```
public ReadToken setLookup(boolean lookup)
```
true if a lookup is necessary, default false

unsetLookup
```
public void unsetLookup()
```

isSetLookup
```
public boolean isSetLookup()
```
Returns true if field lookup is set (has been assigned a value) and false otherwise

setLookupIsSet

public void setLookupIsSet(boolean value)

isGroovy
```
public boolean isGroovy()
```
DEPRECATED. Groovy scripting enabled, default false

setGroovy
```
public ReadToken setGroovy(boolean groovy)
```
DEPRECATED. Groovy scripting enabled, default false

unsetGroovy
```
public void unsetGroovy()
```

isSetGroovy
```
public boolean isSetGroovy()
```
Returns true if field groovy is set (has been assigned a value) and false otherwise

setGroovyIsSet

public void setGroovyIsSet(boolean value)

getMaxFetchSize
```
public long getMaxFetchSize()
```
DEPRECATED Max fetch size in bytes of each read request, default 16Mb

setMaxFetchSize
```
public ReadToken setMaxFetchSize(long maxFetchSize)
```
DEPRECATED Max fetch size in bytes of each read request, default 16Mb

unsetMaxFetchSize
```
public void unsetMaxFetchSize()
```

isSetMaxFetchSize
```
public boolean isSetMaxFetchSize()
```
Returns true if field maxFetchSize is set (has been assigned a value) and false otherwise

setMaxFetchSizeIsSet

public void setMaxFetchSizeIsSet(boolean value)

getAppName
```
public java.lang.String getAppName()
```
Name of the application using the token

setAppName

public ReadToken setAppName(java.lang.String appName)

Name of the application using the token

unsetAppName
```
public void unsetAppName()
```

isSetAppName
```
public boolean isSetAppName()
```
Returns true if field appName is set (has been assigned a value) and false otherwise

setAppNameIsSet

public void setAppNameIsSet(boolean value)

getAppsSize
```
public int getAppsSize()
```

getAppsIterator

public java.util.Iterator<java.lang.String> getAppsIterator()

addToApps

public void addToApps(java.lang.String elem)

getApps

public java.util.List<java.lang.String> getApps()

List of applications consumed

setApps

public ReadToken setApps(java.util.List<java.lang.String> apps)

List of applications consumed

unsetApps
```
public void unsetApps()
```

isSetApps
```
public boolean isSetApps()
```
Returns true if field apps is set (has been assigned a value) and false otherwise

setAppsIsSet

public void setAppsIsSet(boolean value)

getOwnersSize
```
public int getOwnersSize()
```

getOwnersIterator

public java.util.Iterator<java.nio.ByteBuffer> getOwnersIterator()

addToOwners

public void addToOwners(java.nio.ByteBuffer elem)

getOwners

public java.util.List<java.nio.ByteBuffer> getOwners()

List of owners

setOwners

public ReadToken setOwners(java.util.List<java.nio.ByteBuffer> owners)

List of owners

unsetOwners
```
public void unsetOwners()
```

isSetOwners
```
public boolean isSetOwners()
```
Returns true if field owners is set (has been assigned a value) and false otherwise

setOwnersIsSet

public void setOwnersIsSet(boolean value)

getProducersSize
```
public int getProducersSize()
```

getProducersIterator

public java.util.Iterator<java.nio.ByteBuffer> getProducersIterator()

addToProducers

public void addToProducers(java.nio.ByteBuffer elem)

getProducers

public java.util.List<java.nio.ByteBuffer> getProducers()

List of producers

setProducers

public ReadToken setProducers(java.util.List<java.nio.ByteBuffer> producers)

List of producers

unsetProducers
```
public void unsetProducers()
```

isSetProducers
```
public boolean isSetProducers()
```
Returns true if field producers is set (has been assigned a value) and false otherwise

setProducersIsSet

public void setProducersIsSet(boolean value)

getBilledId
```
public byte[] getBilledId()
```
Id of the billed customer

bufferForBilledId

public java.nio.ByteBuffer bufferForBilledId()

setBilledId

public ReadToken setBilledId(byte[] billedId)

Id of the billed customer

setBilledId

public ReadToken setBilledId(java.nio.ByteBuffer billedId)

unsetBilledId
```
public void unsetBilledId()
```

isSetBilledId
```
public boolean isSetBilledId()
```
Returns true if field billedId is set (has been assigned a value) and false otherwise

setBilledIdIsSet

public void setBilledIdIsSet(boolean value)

getHooksSize
```
public int getHooksSize()
```

putToHooks

public void putToHooks(java.lang.String key,
                       java.lang.String val)

getHooks

public java.util.Map<java.lang.String,java.lang.String> getHooks()

Token hooks

setHooks

public ReadToken setHooks(java.util.Map<java.lang.String,java.lang.String> hooks)

Token hooks

unsetHooks
```
public void unsetHooks()
```

isSetHooks
```
public boolean isSetHooks()
```
Returns true if field hooks is set (has been assigned a value) and false otherwise

setHooksIsSet

public void setHooksIsSet(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()

Token attributes

setAttributes

public ReadToken setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Token attributes

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)

getLabelsSize
```
public int getLabelsSize()
```

putToLabels

public void putToLabels(java.lang.String key,
                        java.lang.String val)

getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
Token extra labels. These are label selectors which will be added to the query parameters to restrain the set of returned Geo Time Series.

setLabels
```
public ReadToken setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
Token extra labels. These are label selectors which will be added to the query parameters to restrain the set of returned Geo Time Series.

unsetLabels
```
public void unsetLabels()
```

isSetLabels
```
public boolean isSetLabels()
```
Returns true if field labels is set (has been assigned a value) and false otherwise

setLabelsIsSet

public void setLabelsIsSet(boolean value)

isDataviz
```
public boolean isDataviz()
```
The read token is used for data visualisation, default false

setDataviz
```
public ReadToken setDataviz(boolean dataviz)
```
The read token is used for data visualisation, default false

unsetDataviz
```
public void unsetDataviz()
```

isSetDataviz
```
public boolean isSetDataviz()
```
Returns true if field dataviz is set (has been assigned a value) and false otherwise

setDatavizIsSet

public void setDatavizIsSet(boolean value)

setFieldValue

public void setFieldValue(ReadToken._Fields field,
                          java.lang.Object value)

Specified by:: setFieldValue in interface org.apache.thrift.TBase<ReadToken,ReadToken._Fields>

getFieldValue
```
public java.lang.Object getFieldValue(ReadToken._Fields field)
```
Specified by:

getFieldValue in interface org.apache.thrift.TBase<ReadToken,ReadToken._Fields>

isSet
```
public boolean isSet(ReadToken._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<ReadToken,ReadToken._Fields>

equals

public boolean equals(java.lang.Object that)

Overrides:: equals in class java.lang.Object

equals

public boolean equals(ReadToken that)

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

compareTo
```
public int compareTo(ReadToken other)
```
Specified by:

compareTo in interface java.lang.Comparable<ReadToken>

fieldForId
```
public ReadToken._Fields fieldForId(int fieldId)
```
Specified by:

fieldForId in interface org.apache.thrift.TBase<ReadToken,ReadToken._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 ReadToken

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaDataMap

Constructor Detail

ReadToken

ReadToken

ReadToken

Method Detail

deepCopy

clear

getIssuanceTimestamp

setIssuanceTimestamp

unsetIssuanceTimestamp

isSetIssuanceTimestamp

setIssuanceTimestampIsSet

getExpiryTimestamp

setExpiryTimestamp

unsetExpiryTimestamp

isSetExpiryTimestamp

setExpiryTimestampIsSet

getTokenType

setTokenType

unsetTokenType

isSetTokenType

setTokenTypeIsSet

isLookup

setLookup

unsetLookup

isSetLookup

setLookupIsSet

isGroovy

setGroovy

unsetGroovy

isSetGroovy

setGroovyIsSet

getMaxFetchSize

setMaxFetchSize

unsetMaxFetchSize

isSetMaxFetchSize

setMaxFetchSizeIsSet

getAppName

setAppName

unsetAppName

isSetAppName

setAppNameIsSet

getAppsSize

getAppsIterator

addToApps

getApps

setApps

unsetApps

isSetApps

setAppsIsSet

getOwnersSize

getOwnersIterator

addToOwners

getOwners

setOwners

unsetOwners

isSetOwners

setOwnersIsSet

getProducersSize

getProducersIterator

addToProducers

getProducers

setProducers

unsetProducers

isSetProducers

setProducersIsSet

getBilledId

bufferForBilledId

setBilledId

setBilledId

unsetBilledId

isSetBilledId