Package com.couchbase.client.core.msg.search

Class GenericSearchRequest

java.lang.Object

com.couchbase.client.core.msg.BaseRequest<GenericSearchResponse>

com.couchbase.client.core.msg.search.GenericSearchRequest

All Implemented Interfaces:

Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>, NonChunkedHttpRequest<GenericSearchResponse>, Request<GenericSearchResponse>

public class GenericSearchRequest
extends BaseRequest<GenericSearchResponse>
implements NonChunkedHttpRequest<GenericSearchResponse>

Constructor Summary

Constructors

Constructor	Description
GenericSearchRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Supplier<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest> requestSupplier, boolean idempotent, RequestSpan span, String indexName, String path)

Method Summary

Modifier and Type	Method	Description
GenericSearchResponse	decode(com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpResponse response, HttpChannelContext context)
com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest	encode()
boolean	idempotent()	Returns if the given request is idempotent or not.
Map<String,Object>	serviceContext()	Returns contextual information for each individual service.
ServiceType	serviceType()	The service type of this request.

Methods inherited from class com.couchbase.client.core.msg.BaseRequest

absoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, requestSpan, 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, name, operationId, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed

Constructor Details

GenericSearchRequest

public GenericSearchRequest(Duration timeout,
CoreContext ctx,
RetryStrategy retryStrategy,
Supplier<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest> requestSupplier,
boolean idempotent,
RequestSpan span,
String indexName,
String path)

Method Details

decode

public GenericSearchResponse decode(com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpResponse response,
HttpChannelContext context)

Specified by:

decode in interface NonChunkedHttpRequest<GenericSearchResponse>

encode

public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()

Specified by:

encode in interface Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>

serviceType

public ServiceType serviceType()

Description copied from interface: Request

The service type of this request.

Specified by:

serviceType in interface Request<GenericSearchResponse>

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 interface Request<GenericSearchResponse>

Returns:

true if idempotent.

serviceContext

public Map<String,Object> serviceContext()

Description copied from interface: Request

Returns contextual information for each individual service.

Specified by:

serviceContext in interface Request<GenericSearchResponse>

Overrides:

serviceContext in class BaseRequest<GenericSearchResponse>

Returns:

the service context.