Package io.confluent.ksql.api.client
Interface QueryInfo
-
public interface QueryInfo
Metadata for a ksqlDB query.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
QueryInfo.QueryType
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getId()
Returns the ID of this query, used for control operations such as terminating the query.QueryInfo.QueryType
getQueryType()
Optional<String>
getSink()
Returns the name of the sink ksqlDB stream or table that this query writes to, if this query is persistent.Optional<String>
getSinkTopic()
Returns the name of the Kafka topic that backs the sink ksqlDB stream or table that this query writes to, if this query is persistent.String
getSql()
Returns the ksqlDB statement text corresponding to this query.
-
-
-
Method Detail
-
getQueryType
QueryInfo.QueryType getQueryType()
- Returns:
- the type of this query
-
getId
String getId()
Returns the ID of this query, used for control operations such as terminating the query.- Returns:
- the ID of this query
-
getSql
String getSql()
Returns the ksqlDB statement text corresponding to this query. This text may not be exactly the statement submitted in order to start the query, but submitting this statement will result in exactly this query.- Returns:
- the ksqlDB statement text
-
getSink
Optional<String> getSink()
Returns the name of the sink ksqlDB stream or table that this query writes to, if this query is persistent. If this query is a push query, then the returned optional will be empty.- Returns:
- the sink ksqlDB stream or table name, if applicable
-
getSinkTopic
Optional<String> getSinkTopic()
Returns the name of the Kafka topic that backs the sink ksqlDB stream or table that this query writes to, if this query is persistent. If this query is a push query, then the returned optional will be empty.- Returns:
- the sink Kafka topic name, if applicable
-
-