java.lang.Object
- org.apache.pinot.common.request.PinotQuery

All Implemented Interfaces:: Serializable, Cloneable, Comparable<PinotQuery>, org.apache.thrift.TBase<PinotQuery,PinotQuery._Fields>, org.apache.thrift.TSerializable

@Generated(value="Autogenerated by Thrift Compiler (0.15.0)",
           date="2022-05-02")
public class PinotQuery
extends Object
implements org.apache.thrift.TBase<PinotQuery,PinotQuery._Fields>, Serializable, Cloneable, Comparable<PinotQuery>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

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

Field Summary

Fields
Modifier and Type	Field	Description
`DataSource`	`dataSource`
`Map<String,String>`	`debugOptions`
`boolean`	`explain`
`Map<Expression,Expression>`	`expressionOverrideHints`
`Expression`	`filterExpression`
`List<Expression>`	`groupByList`
`Expression`	`havingExpression`
`int`	`limit`
`static Map<PinotQuery._Fields,org.apache.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`int`	`offset`
`List<Expression>`	`orderByList`
`Map<String,String>`	`queryOptions`
`List<Expression>`	`selectList`
`int`	`version`

Constructor Summary

Constructors
Constructor Description

PinotQuery()

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addToGroupByList(Expression elem)`
`void`	`addToOrderByList(Expression elem)`
`void`	`addToSelectList(Expression elem)`
`void`	`clear()`
`int`	`compareTo(PinotQuery other)`
`PinotQuery`	`deepCopy()`
`boolean`	`equals(Object that)`
`boolean`	`equals(PinotQuery that)`
`PinotQuery._Fields`	`fieldForId(int fieldId)`
`DataSource`	`getDataSource()`
`Map<String,String>`	`getDebugOptions()`
`int`	`getDebugOptionsSize()`
`Map<Expression,Expression>`	`getExpressionOverrideHints()`
`int`	`getExpressionOverrideHintsSize()`
`Object`	`getFieldValue(PinotQuery._Fields field)`
`Expression`	`getFilterExpression()`
`List<Expression>`	`getGroupByList()`
`Iterator<Expression>`	`getGroupByListIterator()`
`int`	`getGroupByListSize()`
`Expression`	`getHavingExpression()`
`int`	`getLimit()`
`int`	`getOffset()`
`List<Expression>`	`getOrderByList()`
`Iterator<Expression>`	`getOrderByListIterator()`
`int`	`getOrderByListSize()`
`Map<String,String>`	`getQueryOptions()`
`int`	`getQueryOptionsSize()`
`List<Expression>`	`getSelectList()`
`Iterator<Expression>`	`getSelectListIterator()`
`int`	`getSelectListSize()`
`int`	`getVersion()`
`int`	`hashCode()`
`boolean`	`isExplain()`
`boolean`	`isSet(PinotQuery._Fields field)`	Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetDataSource()`	Returns true if field dataSource is set (has been assigned a value) and false otherwise
`boolean`	`isSetDebugOptions()`	Returns true if field debugOptions is set (has been assigned a value) and false otherwise
`boolean`	`isSetExplain()`	Returns true if field explain is set (has been assigned a value) and false otherwise
`boolean`	`isSetExpressionOverrideHints()`	Returns true if field expressionOverrideHints is set (has been assigned a value) and false otherwise
`boolean`	`isSetFilterExpression()`	Returns true if field filterExpression is set (has been assigned a value) and false otherwise
`boolean`	`isSetGroupByList()`	Returns true if field groupByList is set (has been assigned a value) and false otherwise
`boolean`	`isSetHavingExpression()`	Returns true if field havingExpression is set (has been assigned a value) and false otherwise
`boolean`	`isSetLimit()`	Returns true if field limit is set (has been assigned a value) and false otherwise
`boolean`	`isSetOffset()`	Returns true if field offset is set (has been assigned a value) and false otherwise
`boolean`	`isSetOrderByList()`	Returns true if field orderByList is set (has been assigned a value) and false otherwise
`boolean`	`isSetQueryOptions()`	Returns true if field queryOptions is set (has been assigned a value) and false otherwise
`boolean`	`isSetSelectList()`	Returns true if field selectList is set (has been assigned a value) and false otherwise
`boolean`	`isSetVersion()`	Returns true if field version is set (has been assigned a value) and false otherwise
`void`	`putToDebugOptions(String key, String val)`
`void`	`putToExpressionOverrideHints(Expression key, Expression val)`
`void`	`putToQueryOptions(String key, String val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`PinotQuery`	`setDataSource(DataSource dataSource)`
`void`	`setDataSourceIsSet(boolean value)`
`PinotQuery`	`setDebugOptions(Map<String,String> debugOptions)`
`void`	`setDebugOptionsIsSet(boolean value)`
`PinotQuery`	`setExplain(boolean explain)`
`void`	`setExplainIsSet(boolean value)`
`PinotQuery`	`setExpressionOverrideHints(Map<Expression,Expression> expressionOverrideHints)`
`void`	`setExpressionOverrideHintsIsSet(boolean value)`
`void`	`setFieldValue(PinotQuery._Fields field, Object value)`
`PinotQuery`	`setFilterExpression(Expression filterExpression)`
`void`	`setFilterExpressionIsSet(boolean value)`
`PinotQuery`	`setGroupByList(List<Expression> groupByList)`
`void`	`setGroupByListIsSet(boolean value)`
`PinotQuery`	`setHavingExpression(Expression havingExpression)`
`void`	`setHavingExpressionIsSet(boolean value)`
`PinotQuery`	`setLimit(int limit)`
`void`	`setLimitIsSet(boolean value)`
`PinotQuery`	`setOffset(int offset)`
`void`	`setOffsetIsSet(boolean value)`
`PinotQuery`	`setOrderByList(List<Expression> orderByList)`
`void`	`setOrderByListIsSet(boolean value)`
`PinotQuery`	`setQueryOptions(Map<String,String> queryOptions)`
`void`	`setQueryOptionsIsSet(boolean value)`
`PinotQuery`	`setSelectList(List<Expression> selectList)`
`void`	`setSelectListIsSet(boolean value)`
`PinotQuery`	`setVersion(int version)`
`void`	`setVersionIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetDataSource()`
`void`	`unsetDebugOptions()`
`void`	`unsetExplain()`
`void`	`unsetExpressionOverrideHints()`
`void`	`unsetFilterExpression()`
`void`	`unsetGroupByList()`
`void`	`unsetHavingExpression()`
`void`	`unsetLimit()`
`void`	`unsetOffset()`
`void`	`unsetOrderByList()`
`void`	`unsetQueryOptions()`
`void`	`unsetSelectList()`
`void`	`unsetVersion()`
`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

version
```
public int version
```

dataSource
```
public DataSource dataSource
```

selectList
```
public List<Expression> selectList
```

filterExpression
```
public Expression filterExpression
```

groupByList
```
public List<Expression> groupByList
```

orderByList
```
public List<Expression> orderByList
```

havingExpression
```
public Expression havingExpression
```

limit
```
public int limit
```

offset
```
public int offset
```

debugOptions

public Map<String,String> debugOptions

queryOptions

public Map<String,String> queryOptions

explain
```
public boolean explain
```

expressionOverrideHints

public Map<Expression,Expression> expressionOverrideHints

metaDataMap

public static final Map<PinotQuery._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

Constructor Detail
- PinotQuery
```
public PinotQuery()
```
- PinotQuery
```
public PinotQuery(PinotQuery other)
```
  Performs a deep copy on other.

Method Detail

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

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

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

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

getVersion
```
public int getVersion()
```

setVersion

public PinotQuery setVersion(int version)

unsetVersion
```
public void unsetVersion()
```

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

setVersionIsSet

public void setVersionIsSet(boolean value)

getDataSource
```
public DataSource getDataSource()
```

setDataSource

public PinotQuery setDataSource(DataSource dataSource)

unsetDataSource
```
public void unsetDataSource()
```

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

setDataSourceIsSet

public void setDataSourceIsSet(boolean value)

getSelectListSize
```
public int getSelectListSize()
```

getSelectListIterator

public Iterator<Expression> getSelectListIterator()

addToSelectList

public void addToSelectList(Expression elem)

getSelectList

public List<Expression> getSelectList()

setSelectList

public PinotQuery setSelectList(List<Expression> selectList)

unsetSelectList
```
public void unsetSelectList()
```

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

setSelectListIsSet

public void setSelectListIsSet(boolean value)

getFilterExpression

public Expression getFilterExpression()

setFilterExpression

public PinotQuery setFilterExpression(Expression filterExpression)

unsetFilterExpression
```
public void unsetFilterExpression()
```

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

setFilterExpressionIsSet

public void setFilterExpressionIsSet(boolean value)

getGroupByListSize
```
public int getGroupByListSize()
```

getGroupByListIterator

public Iterator<Expression> getGroupByListIterator()

addToGroupByList

public void addToGroupByList(Expression elem)

getGroupByList

public List<Expression> getGroupByList()

setGroupByList

public PinotQuery setGroupByList(List<Expression> groupByList)

unsetGroupByList
```
public void unsetGroupByList()
```

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

setGroupByListIsSet

public void setGroupByListIsSet(boolean value)

getOrderByListSize
```
public int getOrderByListSize()
```

getOrderByListIterator

public Iterator<Expression> getOrderByListIterator()

addToOrderByList

public void addToOrderByList(Expression elem)

getOrderByList

public List<Expression> getOrderByList()

setOrderByList

public PinotQuery setOrderByList(List<Expression> orderByList)

unsetOrderByList
```
public void unsetOrderByList()
```

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

setOrderByListIsSet

public void setOrderByListIsSet(boolean value)

getHavingExpression

public Expression getHavingExpression()

setHavingExpression

public PinotQuery setHavingExpression(Expression havingExpression)

unsetHavingExpression
```
public void unsetHavingExpression()
```

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

setHavingExpressionIsSet

public void setHavingExpressionIsSet(boolean value)

getLimit
```
public int getLimit()
```

setLimit

public PinotQuery setLimit(int limit)

unsetLimit
```
public void unsetLimit()
```

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

setLimitIsSet

public void setLimitIsSet(boolean value)

getOffset
```
public int getOffset()
```

setOffset

public PinotQuery setOffset(int offset)

unsetOffset
```
public void unsetOffset()
```

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

setOffsetIsSet

public void setOffsetIsSet(boolean value)

getDebugOptionsSize
```
public int getDebugOptionsSize()
```

putToDebugOptions

public void putToDebugOptions(String key,
                              String val)

getDebugOptions

public Map<String,String> getDebugOptions()

setDebugOptions

public PinotQuery setDebugOptions(Map<String,String> debugOptions)

unsetDebugOptions
```
public void unsetDebugOptions()
```

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

setDebugOptionsIsSet

public void setDebugOptionsIsSet(boolean value)

getQueryOptionsSize
```
public int getQueryOptionsSize()
```

putToQueryOptions

public void putToQueryOptions(String key,
                              String val)

getQueryOptions

public Map<String,String> getQueryOptions()

setQueryOptions

public PinotQuery setQueryOptions(Map<String,String> queryOptions)

unsetQueryOptions
```
public void unsetQueryOptions()
```

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

setQueryOptionsIsSet

public void setQueryOptionsIsSet(boolean value)

isExplain
```
public boolean isExplain()
```

setExplain

public PinotQuery setExplain(boolean explain)

unsetExplain
```
public void unsetExplain()
```

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

setExplainIsSet

public void setExplainIsSet(boolean value)

getExpressionOverrideHintsSize

public int getExpressionOverrideHintsSize()

putToExpressionOverrideHints

public void putToExpressionOverrideHints(Expression key,
                                         Expression val)

getExpressionOverrideHints

public Map<Expression,Expression> getExpressionOverrideHints()

setExpressionOverrideHints

public PinotQuery setExpressionOverrideHints(Map<Expression,Expression> expressionOverrideHints)

unsetExpressionOverrideHints

public void unsetExpressionOverrideHints()

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

setExpressionOverrideHintsIsSet

public void setExpressionOverrideHintsIsSet(boolean value)

setFieldValue

public void setFieldValue(PinotQuery._Fields field,
                          Object value)

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

getFieldValue
```
public Object getFieldValue(PinotQuery._Fields field)
```
Specified by:

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

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

equals

public boolean equals(Object that)

Overrides:: equals in class Object

equals

public boolean equals(PinotQuery that)

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

hashCode in class Object

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

compareTo in interface Comparable<PinotQuery>

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

fieldForId in interface org.apache.thrift.TBase<PinotQuery,PinotQuery._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 String toString()
```
Overrides:

toString in class Object

validate

public void validate()
              throws org.apache.thrift.TException

Throws:: org.apache.thrift.TException

Constructor	Description
`PinotQuery()`
`PinotQuery(PinotQuery other)`	Performs a deep copy on other.

Class PinotQuery

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

dataSource

selectList

filterExpression

groupByList

orderByList

havingExpression

limit

offset

debugOptions

queryOptions

explain

expressionOverrideHints

metaDataMap

Constructor Detail

PinotQuery

PinotQuery

Method Detail

deepCopy

clear

getVersion

setVersion

unsetVersion

isSetVersion

setVersionIsSet

getDataSource

setDataSource

unsetDataSource

isSetDataSource

setDataSourceIsSet

getSelectListSize

getSelectListIterator

addToSelectList

getSelectList

setSelectList

unsetSelectList

isSetSelectList

setSelectListIsSet

getFilterExpression

setFilterExpression

unsetFilterExpression

isSetFilterExpression

setFilterExpressionIsSet

getGroupByListSize

getGroupByListIterator

addToGroupByList

getGroupByList

setGroupByList

unsetGroupByList

isSetGroupByList

setGroupByListIsSet

getOrderByListSize

getOrderByListIterator

addToOrderByList

getOrderByList

setOrderByList

unsetOrderByList

isSetOrderByList

setOrderByListIsSet

getHavingExpression

setHavingExpression

unsetHavingExpression

isSetHavingExpression

setHavingExpressionIsSet

getLimit

setLimit

unsetLimit

isSetLimit

setLimitIsSet

getOffset

setOffset

unsetOffset

isSetOffset