Class CoreQueryMetaData
- java.lang.Object
-
- com.couchbase.client.core.api.query.CoreQueryMetaData
-
- Direct Known Subclasses:
ClassicCoreQueryMetaData
,ProtostellarCoreQueryMetaData
@Internal public abstract class CoreQueryMetaData extends Object
-
-
Constructor Summary
Constructors Constructor Description CoreQueryMetaData()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract String
clientContextId()
Returns the client context identifier string set on the query request.abstract Optional<CoreQueryMetrics>
metrics()
Returns theCoreQueryMetrics
as returned by the query engine if enabled.abstract Optional<byte[]>
profile()
Returns the profiling information.abstract String
requestId()
Returns the request identifier string of the query requestabstract Optional<byte[]>
signature()
Returns the signature.abstract CoreQueryStatus
status()
Returns the raw query execution status as returned by the query engineabstract List<CoreQueryWarning>
warnings()
Returns any warnings returned by the query engine.
-
-
-
Method Detail
-
requestId
public abstract String requestId()
Returns the request identifier string of the query request
-
clientContextId
public abstract String clientContextId()
Returns the client context identifier string set on the query request.
-
status
public abstract CoreQueryStatus status()
Returns the raw query execution status as returned by the query engine
-
signature
public abstract Optional<byte[]> signature()
Returns the signature.It is returned as an Optional which will be empty if no signature information is available.
- Throws:
DecodingFailureException
- when the signature cannot be decoded successfully
-
profile
public abstract Optional<byte[]> profile()
Returns the profiling information.It is returned as an Optional which will be empty if no profile information is available.
- Throws:
DecodingFailureException
- when the profile cannot be decoded successfully
-
metrics
public abstract Optional<CoreQueryMetrics> metrics()
Returns theCoreQueryMetrics
as returned by the query engine if enabled.- Throws:
DecodingFailureException
- when the metrics cannot be decoded successfully
-
warnings
public abstract List<CoreQueryWarning> warnings()
Returns any warnings returned by the query engine.It is returned as an Optional which will be empty if no warnings were returned
- Throws:
DecodingFailureException
- when the warnings cannot be decoded successfully
-
-