WriteToken (warpscript 2.8.1-rc0 API)

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

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<WriteToken>, org.apache.thrift.TBase<WriteToken,WriteToken._Fields>, org.apache.thrift.TSerializable

@Generated(value="Autogenerated by Thrift Compiler (0.11.0)",
           date="2021-05-05")
public class WriteToken
extends java.lang.Object
implements org.apache.thrift.TBase<WriteToken,WriteToken._Fields>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<WriteToken>

See Also:: Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors
Constructor and Description
`WriteToken()`
`WriteToken(long issuanceTimestamp, long expiryTimestamp, TokenType tokenType, java.nio.ByteBuffer producerId, java.nio.ByteBuffer ownerId, java.lang.String appName)`
`WriteToken(WriteToken other)` Performs a deep copy on other.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addToIndices(long elem)`
`java.nio.ByteBuffer`	`bufferForOwnerId()`
`java.nio.ByteBuffer`	`bufferForProducerId()`
`void`	`clear()`
`int`	`compareTo(WriteToken other)`
`WriteToken`	`deepCopy()`
`boolean`	`equals(java.lang.Object that)`
`boolean`	`equals(WriteToken that)`
`WriteToken._Fields`	`fieldForId(int fieldId)`
`java.lang.String`	`getAppName()` Application name
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Token attributes, placeholder to store K/V.
`int`	`getAttributesSize()`
`long`	`getExpiryTimestamp()` Timestamp of the token expiration
`java.lang.Object`	`getFieldValue(WriteToken._Fields field)`
`java.util.List<java.lang.Long>`	`getIndices()` indices to use
`java.util.Iterator<java.lang.Long>`	`getIndicesIterator()`
`int`	`getIndicesSize()`
`long`	`getIssuanceTimestamp()` delivery timestamp of the token
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` Default labels.
`int`	`getLabelsSize()`
`byte[]`	`getOwnerId()` ident of the owner
`byte[]`	`getProducerId()` ident of the producer a producer inject data, but is not the data owner
`TokenType`	`getTokenType()` TokenType (Set to TokenType.WRITE)
`int`	`hashCode()`
`boolean`	`isLookup()` true if a lookup is necessary, default false
`boolean`	`isSet(WriteToken._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`	`isSetAttributes()` Returns true if field attributes 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`	`isSetIndices()` Returns true if field indices 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`	`isSetOwnerId()` Returns true if field ownerId is set (has been assigned a value) and false otherwise
`boolean`	`isSetProducerId()` Returns true if field producerId 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`	`putToLabels(java.lang.String key, java.lang.String val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`WriteToken`	`setAppName(java.lang.String appName)` Application name
`void`	`setAppNameIsSet(boolean value)`
`WriteToken`	`setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)` Token attributes, placeholder to store K/V.
`void`	`setAttributesIsSet(boolean value)`
`WriteToken`	`setExpiryTimestamp(long expiryTimestamp)` Timestamp of the token expiration
`void`	`setExpiryTimestampIsSet(boolean value)`
`void`	`setFieldValue(WriteToken._Fields field, java.lang.Object value)`
`WriteToken`	`setIndices(java.util.List<java.lang.Long> indices)` indices to use
`void`	`setIndicesIsSet(boolean value)`
`WriteToken`	`setIssuanceTimestamp(long issuanceTimestamp)` delivery timestamp of the token
`void`	`setIssuanceTimestampIsSet(boolean value)`
`WriteToken`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Default labels.
`void`	`setLabelsIsSet(boolean value)`
`WriteToken`	`setLookup(boolean lookup)` true if a lookup is necessary, default false
`void`	`setLookupIsSet(boolean value)`
`WriteToken`	`setOwnerId(byte[] ownerId)` ident of the owner
`WriteToken`	`setOwnerId(java.nio.ByteBuffer ownerId)`
`void`	`setOwnerIdIsSet(boolean value)`
`WriteToken`	`setProducerId(byte[] producerId)` ident of the producer a producer inject data, but is not the data owner
`WriteToken`	`setProducerId(java.nio.ByteBuffer producerId)`
`void`	`setProducerIdIsSet(boolean value)`
`WriteToken`	`setTokenType(TokenType tokenType)` TokenType (Set to TokenType.WRITE)
`void`	`setTokenTypeIsSet(boolean value)`
`java.lang.String`	`toString()`
`void`	`unsetAppName()`
`void`	`unsetAttributes()`
`void`	`unsetExpiryTimestamp()`
`void`	`unsetIndices()`
`void`	`unsetIssuanceTimestamp()`
`void`	`unsetLabels()`
`void`	`unsetLookup()`
`void`	`unsetOwnerId()`
`void`	`unsetProducerId()`
`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<WriteToken._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

Constructor Detail

WriteToken
```
public WriteToken()
```

WriteToken

public WriteToken(long issuanceTimestamp,
                  long expiryTimestamp,
                  TokenType tokenType,
                  java.nio.ByteBuffer producerId,
                  java.nio.ByteBuffer ownerId,
                  java.lang.String appName)

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

Method Detail
- deepCopy
```
public WriteToken deepCopy()
```
  Specified by:
  
  deepCopy in interface org.apache.thrift.TBase<WriteToken,WriteToken._Fields>
- clear
```
public void clear()
```
  Specified by:
  
  clear in interface org.apache.thrift.TBase<WriteToken,WriteToken._Fields>
- getIssuanceTimestamp
```
public long getIssuanceTimestamp()
```
  delivery timestamp of the token
- setIssuanceTimestamp
```
public WriteToken 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 WriteToken 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.WRITE)
  
  See Also:
  
  TokenType
- setTokenType
```
public WriteToken setTokenType(TokenType tokenType)
```
  TokenType (Set to TokenType.WRITE)
  
  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 WriteToken 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)
```
- getProducerId
```
public byte[] getProducerId()
```
  ident of the producer a producer inject data, but is not the data owner
- bufferForProducerId
```
public java.nio.ByteBuffer bufferForProducerId()
```
- setProducerId
```
public WriteToken setProducerId(byte[] producerId)
```
  ident of the producer a producer inject data, but is not the data owner
- setProducerId
```
public WriteToken setProducerId(java.nio.ByteBuffer producerId)
```
- unsetProducerId
```
public void unsetProducerId()
```
- isSetProducerId
```
public boolean isSetProducerId()
```
  Returns true if field producerId is set (has been assigned a value) and false otherwise
- setProducerIdIsSet
```
public void setProducerIdIsSet(boolean value)
```
- getOwnerId
```
public byte[] getOwnerId()
```
  ident of the owner
- bufferForOwnerId
```
public java.nio.ByteBuffer bufferForOwnerId()
```
- setOwnerId
```
public WriteToken setOwnerId(byte[] ownerId)
```
  ident of the owner
- setOwnerId
```
public WriteToken setOwnerId(java.nio.ByteBuffer ownerId)
```
- unsetOwnerId
```
public void unsetOwnerId()
```
- isSetOwnerId
```
public boolean isSetOwnerId()
```
  Returns true if field ownerId is set (has been assigned a value) and false otherwise
- setOwnerIdIsSet
```
public void setOwnerIdIsSet(boolean value)
```
- getAppName
```
public java.lang.String getAppName()
```
  Application name
- setAppName
```
public WriteToken setAppName(java.lang.String appName)
```
  Application name
- 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)
```
- getIndicesSize
```
public int getIndicesSize()
```
- getIndicesIterator
```
public java.util.Iterator<java.lang.Long> getIndicesIterator()
```
- addToIndices
```
public void addToIndices(long elem)
```
- getIndices
```
public java.util.List<java.lang.Long> getIndices()
```
  indices to use
- setIndices
```
public WriteToken setIndices(java.util.List<java.lang.Long> indices)
```
  indices to use
- unsetIndices
```
public void unsetIndices()
```
- isSetIndices
```
public boolean isSetIndices()
```
  Returns true if field indices is set (has been assigned a value) and false otherwise
- setIndicesIsSet
```
public void setIndicesIsSet(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()
```
  Default labels. Those labels will be added to the Geo Time Series™ labels whenever this token is used for pushing data.
- setLabels
```
public WriteToken setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
  Default labels. Those labels will be added to the Geo Time Series™ labels whenever this token is used for pushing data.
- 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)
```
- 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, placeholder to store K/V. Attributes can be used to limit/augment the use of the token.
- setAttributes
```
public WriteToken setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
```
  Token attributes, placeholder to store K/V. Attributes can be used to limit/augment the use of the token.
- 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(WriteToken._Fields field,
                          java.lang.Object value)
```
  Specified by:
  
  setFieldValue in interface org.apache.thrift.TBase<WriteToken,WriteToken._Fields>
- getFieldValue
```
public java.lang.Object getFieldValue(WriteToken._Fields field)
```
  Specified by:
  
  getFieldValue in interface org.apache.thrift.TBase<WriteToken,WriteToken._Fields>
- isSet
```
public boolean isSet(WriteToken._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<WriteToken,WriteToken._Fields>
- equals
```
public boolean equals(java.lang.Object that)
```
  Overrides:
  
  equals in class java.lang.Object
- equals
```
public boolean equals(WriteToken that)
```
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- compareTo
```
public int compareTo(WriteToken other)
```
  Specified by:
  
  compareTo in interface java.lang.Comparable<WriteToken>
- fieldForId
```
public WriteToken._Fields fieldForId(int fieldId)
```
  Specified by:
  
  fieldForId in interface org.apache.thrift.TBase<WriteToken,WriteToken._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 WriteToken

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaDataMap

Constructor Detail

WriteToken

WriteToken

WriteToken

Method Detail

deepCopy

clear

getIssuanceTimestamp

setIssuanceTimestamp

unsetIssuanceTimestamp

isSetIssuanceTimestamp

setIssuanceTimestampIsSet

getExpiryTimestamp

setExpiryTimestamp

unsetExpiryTimestamp

isSetExpiryTimestamp

setExpiryTimestampIsSet

getTokenType

setTokenType

unsetTokenType

isSetTokenType

setTokenTypeIsSet

isLookup

setLookup

unsetLookup

isSetLookup

setLookupIsSet

getProducerId

bufferForProducerId

setProducerId

setProducerId

unsetProducerId

isSetProducerId

setProducerIdIsSet

getOwnerId

bufferForOwnerId

setOwnerId

setOwnerId

unsetOwnerId

isSetOwnerId

setOwnerIdIsSet

getAppName

setAppName

unsetAppName

isSetAppName

setAppNameIsSet

getIndicesSize

getIndicesIterator

addToIndices

getIndices

setIndices

unsetIndices

isSetIndices

setIndicesIsSet

getLabelsSize

putToLabels

getLabels

setLabels

unsetLabels

isSetLabels

setLabelsIsSet

getAttributesSize

putToAttributes

getAttributes

setAttributes

unsetAttributes

isSetAttributes

setAttributesIsSet

setFieldValue

getFieldValue

isSet

equals