Class AnalyticsRequest
- java.lang.Object
-
- com.couchbase.client.core.msg.BaseRequest<AnalyticsResponse>
-
- com.couchbase.client.core.msg.analytics.AnalyticsRequest
-
- All Implemented Interfaces:
ChunkDecodable<AnalyticsChunkHeader,AnalyticsChunkRow,AnalyticsChunkTrailer,AnalyticsResponse>
,Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>
,HttpRequest<AnalyticsChunkHeader,AnalyticsChunkRow,AnalyticsChunkTrailer,AnalyticsResponse>
,Request<AnalyticsResponse>
public class AnalyticsRequest extends BaseRequest<AnalyticsResponse> implements HttpRequest<AnalyticsChunkHeader,AnalyticsChunkRow,AnalyticsChunkTrailer,AnalyticsResponse>
-
-
Field Summary
Fields Modifier and Type Field Description static int
NO_PRIORITY
static String
OPERATION_NAME
-
Constructor Summary
Constructors Constructor Description AnalyticsRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, byte[] query, int priority, boolean idempotent, String contextId, String statement, InternalSpan span)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalyticsResponse
decode(ResponseStatus status, AnalyticsChunkHeader header, Flux<AnalyticsChunkRow> rows, Mono<AnalyticsChunkTrailer> trailer)
Decodes a chunked response into the response format.com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest
encode()
boolean
idempotent()
Returns if the given request is idempotent or not.String
operationId()
Returns a potentially non-unique identifier that is useful for tracing output.Map<String,Object>
serviceContext()
Returns contextual information for each individual service.ServiceType
serviceType()
The service type of this request.String
statement()
-
Methods inherited from class com.couchbase.client.core.msg.BaseRequest
absoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, internalSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.couchbase.client.core.msg.Request
absoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, internalSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed
-
-
-
-
Field Detail
-
OPERATION_NAME
public static final String OPERATION_NAME
- See Also:
- Constant Field Values
-
NO_PRIORITY
public static final int NO_PRIORITY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
AnalyticsRequest
public AnalyticsRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, byte[] query, int priority, boolean idempotent, String contextId, String statement, InternalSpan span)
-
-
Method Detail
-
encode
public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()
-
decode
public AnalyticsResponse decode(ResponseStatus status, AnalyticsChunkHeader header, Flux<AnalyticsChunkRow> rows, Mono<AnalyticsChunkTrailer> trailer)
Description copied from interface:ChunkDecodable
Decodes a chunked response into the response format.- Specified by:
decode
in interfaceChunkDecodable<AnalyticsChunkHeader,AnalyticsChunkRow,AnalyticsChunkTrailer,AnalyticsResponse>
- Parameters:
status
- the http response status.header
- the chunk header.rows
- the chunk rows.trailer
- the chunk trailer.- Returns:
- a decoded response including all the chunk parts.
-
serviceType
public ServiceType serviceType()
Description copied from interface:Request
The service type of this request.- Specified by:
serviceType
in interfaceRequest<AnalyticsResponse>
- Returns:
- the service type for this request.
-
idempotent
public boolean idempotent()
Description copied from interface:Request
Returns if the given request is idempotent or not.By default, this method always returns false for data consistency reasons. Only specific idempotent operations should override this default since it impacts retry handling quite a bit. DO NOT SET THIS TO TRUE ON MUTATING OPERATIONS!
- Specified by:
idempotent
in interfaceRequest<AnalyticsResponse>
- Returns:
- true if idempotent.
-
operationId
public String operationId()
Description copied from interface:Request
Returns a potentially non-unique identifier that is useful for tracing output.Note: might be null! It depends on the type of operation. It is also different from the unqiue operation ID that increments to provide additional context (i.e in query the context uuid, in kv the opaque value).
- Specified by:
operationId
in interfaceRequest<AnalyticsResponse>
- Returns:
- if present, the operation id. Null otherwise.
-
statement
public String statement()
-
serviceContext
public Map<String,Object> serviceContext()
Description copied from interface:Request
Returns contextual information for each individual service.- Specified by:
serviceContext
in interfaceRequest<AnalyticsResponse>
- Overrides:
serviceContext
in classBaseRequest<AnalyticsResponse>
- Returns:
- the service context.
-
-