Package com.couchbase.client.core.protostellar.query

Class ProtostellarCoreQueryMetaData

java.lang.Object

com.couchbase.client.core.api.query.CoreQueryMetaData

com.couchbase.client.core.protostellar.query.ProtostellarCoreQueryMetaData

@Internal
public class ProtostellarCoreQueryMetaData
extends CoreQueryMetaData

Constructor Summary

Constructors

Constructor	Description
ProtostellarCoreQueryMetaData(com.couchbase.client.protostellar.query.v1.QueryResponse.MetaData metaData)

Method Summary

Modifier and Type	Method	Description
String	clientContextId()	Returns the client context identifier string set on the query request.
Optional<CoreQueryMetrics>	metrics()	Returns the CoreQueryMetrics as returned by the query engine if enabled.
Optional<byte[]>	profile()	Returns the profiling information.
String	requestId()	Returns the request identifier string of the query request
Optional<byte[]>	signature()	Returns the signature.
CoreQueryStatus	status()	Returns the raw query execution status as returned by the query engine
List<CoreQueryWarning>	warnings()	Returns any warnings returned by the query engine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtostellarCoreQueryMetaData

public ProtostellarCoreQueryMetaData(com.couchbase.client.protostellar.query.v1.QueryResponse.MetaData metaData)

Method Detail

requestId

public String requestId()

Description copied from class: CoreQueryMetaData

Returns the request identifier string of the query request

Specified by:

requestId in class CoreQueryMetaData

clientContextId

public String clientContextId()

Description copied from class: CoreQueryMetaData

Returns the client context identifier string set on the query request.

Specified by:

clientContextId in class CoreQueryMetaData

status

public CoreQueryStatus status()

Description copied from class: CoreQueryMetaData

Returns the raw query execution status as returned by the query engine

Specified by:

status in class CoreQueryMetaData

signature

public Optional<byte[]> signature()

Description copied from class: CoreQueryMetaData

Returns the signature.

It is returned as an Optional which will be empty if no signature information is available.

Specified by:

signature in class CoreQueryMetaData

profile

public Optional<byte[]> profile()

Description copied from class: CoreQueryMetaData

Returns the profiling information.

It is returned as an Optional which will be empty if no profile information is available.

Specified by:

profile in class CoreQueryMetaData

metrics

public Optional<CoreQueryMetrics> metrics()

Description copied from class: CoreQueryMetaData

Returns the CoreQueryMetrics as returned by the query engine if enabled.

Specified by:

metrics in class CoreQueryMetaData

warnings

public List<CoreQueryWarning> warnings()

Description copied from class: CoreQueryMetaData

Returns any warnings returned by the query engine.

It is returned as an Optional which will be empty if no warnings were returned

Specified by:

warnings in class CoreQueryMetaData