StateQueryRequest (streams 7.7.7-ce API)

java.lang.Object
- org.apache.kafka.streams.query.StateQueryRequest<R>

Type Parameters:
R - The type of the query result.
```
@InterfaceStability.Evolving
public class StateQueryRequest<R>
extends Object
```
The request object for Interactive Queries. This is an immutable builder class for passing all required and optional arguments for querying a state store in Kafka Streams.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class StateQueryRequest.InStore
A progressive builder interface for creating StoreQueryRequests.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StateQueryRequest.InStore` A progressive builder interface for creating `StoreQueryRequest`s.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StateQueryRequest<R>`	`enableExecutionInfo()` Requests for stores and the Streams runtime to record any useful details about how the query was executed.
`boolean`	`executionInfoEnabled()` Whether the request includes detailed execution information.
`Set<Integer>`	`getPartitions()` If the request is for specific partitions, return the set of partitions to query.
`PositionBound`	`getPositionBound()` The bound that this request places on its query, in terms of the partitions' positions against its inputs.
`Query<R>`	`getQuery()` The query this request is meant to run.
`String`	`getStoreName()` The name of the store this request is for.
`static StateQueryRequest.InStore`	`inStore(String name)` Specifies the name of the store to query.
`boolean`	`isAllPartitions()` Whether this request should fetch from all locally available partitions.
`boolean`	`isRequireActive()` Whether this request requires the query to execute only on active partitions.
`StateQueryRequest<R>`	`requireActive()` Specifies that this query should only run on partitions for which this instance is the leader (aka "active").
`StateQueryRequest<R>`	`withAllPartitions()` Specifies that the query will run against all locally available partitions.
`StateQueryRequest<R>`	`withPartitions(Set<Integer> partitions)` Specifies a set of partitions to run against.
`StateQueryRequest<R>`	`withPositionBound(PositionBound positionBound)` Bounds the position of the state store against its input topics.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - inStore
```
public static StateQueryRequest.InStore inStore(String name)
```
    Specifies the name of the store to query.
  - withPositionBound
```
public StateQueryRequest<R> withPositionBound(PositionBound positionBound)
```
    Bounds the position of the state store against its input topics.
  - withAllPartitions
```
public StateQueryRequest<R> withAllPartitions()
```
    Specifies that the query will run against all locally available partitions.
  - withPartitions
```
public StateQueryRequest<R> withPartitions(Set<Integer> partitions)
```
    Specifies a set of partitions to run against. If some partitions are not locally available, the response will contain a FailureReason.NOT_PRESENT for those partitions. If some partitions in this set are not valid partitions for the store, the response will contain a FailureReason.DOES_NOT_EXIST for those partitions.
  - enableExecutionInfo
```
public StateQueryRequest<R> enableExecutionInfo()
```
    Requests for stores and the Streams runtime to record any useful details about how the query was executed.
  - requireActive
```
public StateQueryRequest<R> requireActive()
```
    Specifies that this query should only run on partitions for which this instance is the leader (aka "active"). Partitions for which this instance is not the active replica will return FailureReason.NOT_ACTIVE.
  - getStoreName
```
public String getStoreName()
```
    The name of the store this request is for.
  - getPositionBound
```
public PositionBound getPositionBound()
```
    The bound that this request places on its query, in terms of the partitions' positions against its inputs.
  - getQuery
```
public Query<R> getQuery()
```
    The query this request is meant to run.
  - isAllPartitions
```
public boolean isAllPartitions()
```
    Whether this request should fetch from all locally available partitions.
  - getPartitions
```
public Set<Integer> getPartitions()
```
    If the request is for specific partitions, return the set of partitions to query.
    Throws:
    IllegalStateException - if this is a request for all partitions
  - executionInfoEnabled
```
public boolean executionInfoEnabled()
```
    Whether the request includes detailed execution information.
  - isRequireActive
```
public boolean isRequireActive()
```
    Whether this request requires the query to execute only on active partitions.

Class StateQueryRequest<R>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

inStore

withPositionBound

withAllPartitions

withPartitions

enableExecutionInfo

requireActive

getStoreName

getPositionBound

getQuery

isAllPartitions

getPartitions

executionInfoEnabled

isRequireActive