Class QueryRequest
- java.lang.Object
-
- com.couchbase.client.core.msg.BaseRequest<QueryResponse>
-
- com.couchbase.client.core.msg.query.QueryRequest
-
- All Implemented Interfaces:
ChunkDecodable<QueryChunkHeader,QueryChunkRow,QueryChunkTrailer,QueryResponse>,Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>,HttpRequest<QueryChunkHeader,QueryChunkRow,QueryChunkTrailer,QueryResponse>,Request<QueryResponse>
public class QueryRequest extends BaseRequest<QueryResponse> implements HttpRequest<QueryChunkHeader,QueryChunkRow,QueryChunkTrailer,QueryResponse>
-
-
Field Summary
Fields Modifier and Type Field Description static StringOPERATION_NAME
-
Constructor Summary
Constructors Constructor Description QueryRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, String statement, byte[] query, boolean idempotent, String contextId, InternalSpan span, String queryContext)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Authenticatorcredentials()QueryResponsedecode(ResponseStatus status, QueryChunkHeader header, Flux<QueryChunkRow> rows, Mono<QueryChunkTrailer> trailer)Decodes a chunked response into the response format.com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequestencode()booleanidempotent()Returns if the given request is idempotent or not.StringoperationId()Returns a potentially non-unique identifier that is useful for tracing output.StringqueryContext()Map<String,Object>serviceContext()Returns contextual information for each individual service.ServiceTypeserviceType()The service type of this request.Stringstatement()-
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
-
-
Constructor Detail
-
QueryRequest
public QueryRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, String statement, byte[] query, boolean idempotent, String contextId, InternalSpan span, String queryContext)
-
-
Method Detail
-
encode
public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()
-
decode
public QueryResponse decode(ResponseStatus status, QueryChunkHeader header, Flux<QueryChunkRow> rows, Mono<QueryChunkTrailer> trailer)
Description copied from interface:ChunkDecodableDecodes a chunked response into the response format.- Specified by:
decodein interfaceChunkDecodable<QueryChunkHeader,QueryChunkRow,QueryChunkTrailer,QueryResponse>- 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:RequestThe service type of this request.- Specified by:
serviceTypein interfaceRequest<QueryResponse>- Returns:
- the service type for this request.
-
statement
public String statement()
-
credentials
public Authenticator credentials()
-
operationId
public String operationId()
Description copied from interface:RequestReturns 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:
operationIdin interfaceRequest<QueryResponse>- Returns:
- if present, the operation id. Null otherwise.
-
idempotent
public boolean idempotent()
Description copied from interface:RequestReturns 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:
idempotentin interfaceRequest<QueryResponse>- Returns:
- true if idempotent.
-
queryContext
public String queryContext()
-
serviceContext
public Map<String,Object> serviceContext()
Description copied from interface:RequestReturns contextual information for each individual service.- Specified by:
serviceContextin interfaceRequest<QueryResponse>- Overrides:
serviceContextin classBaseRequest<QueryResponse>- Returns:
- the service context.
-
-