AnalyticsMetaData (Couchbase Java SDK 3.1.5 API)

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

Modifier and Type	Method	Description
`String`	`clientContextId()`	Get the client context identifier as set by the client
`AnalyticsMetrics`	`metrics()`	Get the associated metrics for the response.
`String`	`requestId()`	Get the request identifier of the query request
`Optional<JsonObject>`	`signature()`	Get the signature as the target type, if present.
`AnalyticsStatus`	`status()`	Get the status of the response.
`String`	`toString()`
`List<AnalyticsWarning>`	`warnings()`	Returns warnings if present.

Methods inherited from class java.lang.Object

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

Method Details
- 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.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object