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

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

@Generated(value="Autogenerated by Thrift Compiler (0.13.0)",
           date="2021-09-28")
public class BrokerRequest
extends Object
implements org.apache.thrift.TBase<BrokerRequest,BrokerRequest._Fields>, Serializable, Cloneable, Comparable<BrokerRequest>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`BrokerRequest._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

static Map<BrokerRequest._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

Constructor Summary

Constructors
Constructor Description

BrokerRequest()

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addToAggregationsInfo(AggregationInfo elem)`
`void`	`addToOrderBy(SelectionSort elem)`
`void`	`clear()`
`int`	`compareTo(BrokerRequest other)`
`BrokerRequest`	`deepCopy()`
`boolean`	`equals(Object that)`
`boolean`	`equals(BrokerRequest that)`
`BrokerRequest._Fields`	`fieldForId(int fieldId)`
`List<AggregationInfo>`	`getAggregationsInfo()`
`Iterator<AggregationInfo>`	`getAggregationsInfoIterator()`
`int`	`getAggregationsInfoSize()`
`String`	`getBucketHashKey()`
`Map<String,String>`	`getDebugOptions()`
`int`	`getDebugOptionsSize()`
`String`	`getDuration()`
`Object`	`getFieldValue(BrokerRequest._Fields field)`
`FilterQuery`	`getFilterQuery()`
`FilterQueryMap`	`getFilterSubQueryMap()`
`GroupBy`	`getGroupBy()`
`HavingFilterQuery`	`getHavingFilterQuery()`
`HavingFilterQueryMap`	`getHavingFilterSubQueryMap()`
`int`	`getLimit()`
`List<SelectionSort>`	`getOrderBy()`
`Iterator<SelectionSort>`	`getOrderByIterator()`
`int`	`getOrderBySize()`
`PinotQuery`	`getPinotQuery()`
`Map<String,String>`	`getQueryOptions()`
`int`	`getQueryOptionsSize()`
`QuerySource`	`getQuerySource()`
`QueryType`	`getQueryType()`
`String`	`getResponseFormat()`
`Selection`	`getSelections()`
`String`	`getTimeInterval()`
`int`	`hashCode()`
`boolean`	`isEnableTrace()`
`boolean`	`isSet(BrokerRequest._Fields field)`	Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
`boolean`	`isSetAggregationsInfo()`	Returns true if field aggregationsInfo is set (has been assigned a value) and false otherwise
`boolean`	`isSetBucketHashKey()`	Returns true if field bucketHashKey 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`	`isSetDuration()`	Returns true if field duration is set (has been assigned a value) and false otherwise
`boolean`	`isSetEnableTrace()`	Returns true if field enableTrace is set (has been assigned a value) and false otherwise
`boolean`	`isSetFilterQuery()`	Returns true if field filterQuery is set (has been assigned a value) and false otherwise
`boolean`	`isSetFilterSubQueryMap()`	Returns true if field filterSubQueryMap is set (has been assigned a value) and false otherwise
`boolean`	`isSetGroupBy()`	Returns true if field groupBy is set (has been assigned a value) and false otherwise
`boolean`	`isSetHavingFilterQuery()`	Returns true if field havingFilterQuery is set (has been assigned a value) and false otherwise
`boolean`	`isSetHavingFilterSubQueryMap()`	Returns true if field havingFilterSubQueryMap 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`	`isSetOrderBy()`	Returns true if field orderBy is set (has been assigned a value) and false otherwise
`boolean`	`isSetPinotQuery()`	Returns true if field pinotQuery 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`	`isSetQuerySource()`	Returns true if field querySource is set (has been assigned a value) and false otherwise
`boolean`	`isSetQueryType()`	Returns true if field queryType is set (has been assigned a value) and false otherwise
`boolean`	`isSetResponseFormat()`	Returns true if field responseFormat is set (has been assigned a value) and false otherwise
`boolean`	`isSetSelections()`	Returns true if field selections is set (has been assigned a value) and false otherwise
`boolean`	`isSetTimeInterval()`	Returns true if field timeInterval is set (has been assigned a value) and false otherwise
`void`	`putToDebugOptions(String key, String val)`
`void`	`putToQueryOptions(String key, String val)`
`void`	`read(org.apache.thrift.protocol.TProtocol iprot)`
`void`	`setAggregationsInfo(List<AggregationInfo> aggregationsInfo)`
`void`	`setAggregationsInfoIsSet(boolean value)`
`void`	`setBucketHashKey(String bucketHashKey)`
`void`	`setBucketHashKeyIsSet(boolean value)`
`void`	`setDebugOptions(Map<String,String> debugOptions)`
`void`	`setDebugOptionsIsSet(boolean value)`
`void`	`setDuration(String duration)`
`void`	`setDurationIsSet(boolean value)`
`void`	`setEnableTrace(boolean enableTrace)`
`void`	`setEnableTraceIsSet(boolean value)`
`void`	`setFieldValue(BrokerRequest._Fields field, Object value)`
`void`	`setFilterQuery(FilterQuery filterQuery)`
`void`	`setFilterQueryIsSet(boolean value)`
`void`	`setFilterSubQueryMap(FilterQueryMap filterSubQueryMap)`
`void`	`setFilterSubQueryMapIsSet(boolean value)`
`void`	`setGroupBy(GroupBy groupBy)`
`void`	`setGroupByIsSet(boolean value)`
`void`	`setHavingFilterQuery(HavingFilterQuery havingFilterQuery)`
`void`	`setHavingFilterQueryIsSet(boolean value)`
`void`	`setHavingFilterSubQueryMap(HavingFilterQueryMap havingFilterSubQueryMap)`
`void`	`setHavingFilterSubQueryMapIsSet(boolean value)`
`void`	`setLimit(int limit)`
`void`	`setLimitIsSet(boolean value)`
`void`	`setOrderBy(List<SelectionSort> orderBy)`
`void`	`setOrderByIsSet(boolean value)`
`void`	`setPinotQuery(PinotQuery pinotQuery)`
`void`	`setPinotQueryIsSet(boolean value)`
`void`	`setQueryOptions(Map<String,String> queryOptions)`
`void`	`setQueryOptionsIsSet(boolean value)`
`void`	`setQuerySource(QuerySource querySource)`
`void`	`setQuerySourceIsSet(boolean value)`
`void`	`setQueryType(QueryType queryType)`
`void`	`setQueryTypeIsSet(boolean value)`
`void`	`setResponseFormat(String responseFormat)`
`void`	`setResponseFormatIsSet(boolean value)`
`void`	`setSelections(Selection selections)`
`void`	`setSelectionsIsSet(boolean value)`
`void`	`setTimeInterval(String timeInterval)`
`void`	`setTimeIntervalIsSet(boolean value)`
`String`	`toString()`
`void`	`unsetAggregationsInfo()`
`void`	`unsetBucketHashKey()`
`void`	`unsetDebugOptions()`
`void`	`unsetDuration()`
`void`	`unsetEnableTrace()`
`void`	`unsetFilterQuery()`
`void`	`unsetFilterSubQueryMap()`
`void`	`unsetGroupBy()`
`void`	`unsetHavingFilterQuery()`
`void`	`unsetHavingFilterSubQueryMap()`
`void`	`unsetLimit()`
`void`	`unsetOrderBy()`
`void`	`unsetPinotQuery()`
`void`	`unsetQueryOptions()`
`void`	`unsetQuerySource()`
`void`	`unsetQueryType()`
`void`	`unsetResponseFormat()`
`void`	`unsetSelections()`
`void`	`unsetTimeInterval()`
`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 Map<BrokerRequest._Fields,org.apache.thrift.meta_data.FieldMetaData> metaDataMap

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

Method Detail

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

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

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

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

getQueryType
```
public QueryType getQueryType()
```

setQueryType

public void setQueryType(QueryType queryType)

unsetQueryType
```
public void unsetQueryType()
```

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

setQueryTypeIsSet

public void setQueryTypeIsSet(boolean value)

getQuerySource
```
public QuerySource getQuerySource()
```

setQuerySource

public void setQuerySource(QuerySource querySource)

unsetQuerySource
```
public void unsetQuerySource()
```

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

setQuerySourceIsSet

public void setQuerySourceIsSet(boolean value)

getTimeInterval
```
public String getTimeInterval()
```

setTimeInterval

public void setTimeInterval(String timeInterval)

unsetTimeInterval
```
public void unsetTimeInterval()
```

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

setTimeIntervalIsSet

public void setTimeIntervalIsSet(boolean value)

getDuration
```
public String getDuration()
```

setDuration

public void setDuration(String duration)

unsetDuration
```
public void unsetDuration()
```

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

setDurationIsSet

public void setDurationIsSet(boolean value)

getFilterQuery
```
public FilterQuery getFilterQuery()
```

setFilterQuery

public void setFilterQuery(FilterQuery filterQuery)

unsetFilterQuery
```
public void unsetFilterQuery()
```

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

setFilterQueryIsSet

public void setFilterQueryIsSet(boolean value)

getAggregationsInfoSize
```
public int getAggregationsInfoSize()
```

getAggregationsInfoIterator

public Iterator<AggregationInfo> getAggregationsInfoIterator()

addToAggregationsInfo

public void addToAggregationsInfo(AggregationInfo elem)

getAggregationsInfo

public List<AggregationInfo> getAggregationsInfo()

setAggregationsInfo

public void setAggregationsInfo(List<AggregationInfo> aggregationsInfo)

unsetAggregationsInfo
```
public void unsetAggregationsInfo()
```

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

setAggregationsInfoIsSet

public void setAggregationsInfoIsSet(boolean value)

getGroupBy
```
public GroupBy getGroupBy()
```

setGroupBy

public void setGroupBy(GroupBy groupBy)

unsetGroupBy
```
public void unsetGroupBy()
```

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

setGroupByIsSet

public void setGroupByIsSet(boolean value)

getSelections
```
public Selection getSelections()
```

setSelections

public void setSelections(Selection selections)

unsetSelections
```
public void unsetSelections()
```

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

setSelectionsIsSet

public void setSelectionsIsSet(boolean value)

getFilterSubQueryMap

public FilterQueryMap getFilterSubQueryMap()

setFilterSubQueryMap

public void setFilterSubQueryMap(FilterQueryMap filterSubQueryMap)

unsetFilterSubQueryMap
```
public void unsetFilterSubQueryMap()
```

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

setFilterSubQueryMapIsSet

public void setFilterSubQueryMapIsSet(boolean value)

getBucketHashKey
```
public String getBucketHashKey()
```

setBucketHashKey

public void setBucketHashKey(String bucketHashKey)

unsetBucketHashKey
```
public void unsetBucketHashKey()
```

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

setBucketHashKeyIsSet

public void setBucketHashKeyIsSet(boolean value)

isEnableTrace
```
public boolean isEnableTrace()
```

setEnableTrace

public void setEnableTrace(boolean enableTrace)

unsetEnableTrace
```
public void unsetEnableTrace()
```

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

setEnableTraceIsSet

public void setEnableTraceIsSet(boolean value)

getResponseFormat
```
public String getResponseFormat()
```

setResponseFormat

public void setResponseFormat(String responseFormat)

unsetResponseFormat
```
public void unsetResponseFormat()
```

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

setResponseFormatIsSet

public void setResponseFormatIsSet(boolean value)

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

putToDebugOptions

public void putToDebugOptions(String key,
                              String val)

getDebugOptions

public Map<String,String> getDebugOptions()

setDebugOptions

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

getHavingFilterQuery

public HavingFilterQuery getHavingFilterQuery()

setHavingFilterQuery

public void setHavingFilterQuery(HavingFilterQuery havingFilterQuery)

unsetHavingFilterQuery
```
public void unsetHavingFilterQuery()
```

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

setHavingFilterQueryIsSet

public void setHavingFilterQueryIsSet(boolean value)

getHavingFilterSubQueryMap

public HavingFilterQueryMap getHavingFilterSubQueryMap()

setHavingFilterSubQueryMap

public void setHavingFilterSubQueryMap(HavingFilterQueryMap havingFilterSubQueryMap)

unsetHavingFilterSubQueryMap

public void unsetHavingFilterSubQueryMap()

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

setHavingFilterSubQueryMapIsSet

public void setHavingFilterSubQueryMapIsSet(boolean value)

getPinotQuery
```
public PinotQuery getPinotQuery()
```

setPinotQuery

public void setPinotQuery(PinotQuery pinotQuery)

unsetPinotQuery
```
public void unsetPinotQuery()
```

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

setPinotQueryIsSet

public void setPinotQueryIsSet(boolean value)

getOrderBySize
```
public int getOrderBySize()
```

getOrderByIterator

public Iterator<SelectionSort> getOrderByIterator()

addToOrderBy

public void addToOrderBy(SelectionSort elem)

getOrderBy

public List<SelectionSort> getOrderBy()

setOrderBy

public void setOrderBy(List<SelectionSort> orderBy)

unsetOrderBy
```
public void unsetOrderBy()
```

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

setOrderByIsSet

public void setOrderByIsSet(boolean value)

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

setLimit
```
public void 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)

setFieldValue

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

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

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

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

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

equals

public boolean equals(Object that)

Overrides:: equals in class Object

equals

public boolean equals(BrokerRequest that)

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

hashCode in class Object

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

compareTo in interface Comparable<BrokerRequest>

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

fieldForId in interface org.apache.thrift.TBase<BrokerRequest,BrokerRequest._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
`BrokerRequest()`
`BrokerRequest(BrokerRequest other)`	Performs a deep copy on other.

Class BrokerRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaDataMap

Constructor Detail

BrokerRequest

BrokerRequest

Method Detail

deepCopy

clear

getQueryType

setQueryType

unsetQueryType

isSetQueryType

setQueryTypeIsSet

getQuerySource

setQuerySource

unsetQuerySource

isSetQuerySource

setQuerySourceIsSet

getTimeInterval

setTimeInterval

unsetTimeInterval

isSetTimeInterval

setTimeIntervalIsSet

getDuration

setDuration

unsetDuration

isSetDuration

setDurationIsSet

getFilterQuery

setFilterQuery

unsetFilterQuery

isSetFilterQuery

setFilterQueryIsSet

getAggregationsInfoSize

getAggregationsInfoIterator

addToAggregationsInfo

getAggregationsInfo

setAggregationsInfo

unsetAggregationsInfo

isSetAggregationsInfo

setAggregationsInfoIsSet

getGroupBy

setGroupBy

unsetGroupBy

isSetGroupBy

setGroupByIsSet

getSelections

setSelections

unsetSelections

isSetSelections

setSelectionsIsSet

getFilterSubQueryMap

setFilterSubQueryMap

unsetFilterSubQueryMap

isSetFilterSubQueryMap

setFilterSubQueryMapIsSet

getBucketHashKey

setBucketHashKey

unsetBucketHashKey

isSetBucketHashKey

setBucketHashKeyIsSet

isEnableTrace

setEnableTrace

unsetEnableTrace

isSetEnableTrace

setEnableTraceIsSet

getResponseFormat

setResponseFormat

unsetResponseFormat

isSetResponseFormat

setResponseFormatIsSet

getDebugOptionsSize

putToDebugOptions

getDebugOptions