Class AnalyticsMetaData
- java.lang.Object
-
- com.couchbase.client.java.analytics.AnalyticsMetaData
-
public class AnalyticsMetaData extends Object
Holds associated metadata returned by the server for the performed analytics request.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringclientContextId()Get the client context identifier as set by the clientAnalyticsMetricsmetrics()Get the associated metrics for the response.Optional<JsonObject>plans()Returns plan information if present.StringrequestId()Get the request identifier of the query requestOptional<JsonObject>signature()Get the signature as the target type, if present.AnalyticsStatusstatus()Get the status of the response.StringtoString()List<AnalyticsWarning>warnings()Returns warnings if present.
-
-
-
Method Detail
-
requestId
public String requestId()
Get the request identifier of the query request- Returns:
- request identifier
-
clientContextId
public String clientContextId()
Get the client context identifier as set by the client- Returns:
- client context identifier
-
status
public AnalyticsStatus status()
Get the status of the response.- Returns:
- the status of the response.
-
signature
public Optional<JsonObject> signature()
Get the signature as the target type, if present.- Returns:
- the decoded signature if present.
-
metrics
public AnalyticsMetrics metrics()
Get the associated metrics for the response.- Returns:
- the metrics for the analytics response.
-
warnings
public List<AnalyticsWarning> warnings()
Returns warnings if present.- Returns:
- warnings, if present.
-
plans
@Internal public Optional<JsonObject> plans()
Returns plan information if present.- Returns:
- plan information if present.
-
-