Class SearchRequest
- java.lang.Object
-
- com.couchbase.client.core.msg.BaseRequest<SearchResponse>
-
- com.couchbase.client.core.msg.search.SearchRequest
-
- All Implemented Interfaces:
ChunkDecodable<SearchChunkHeader,SearchChunkRow,SearchChunkTrailer,SearchResponse>
,Encodable<com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest>
,HttpRequest<SearchChunkHeader,SearchChunkRow,SearchChunkTrailer,SearchResponse>
,Request<SearchResponse>
public class SearchRequest extends BaseRequest<SearchResponse> implements HttpRequest<SearchChunkHeader,SearchChunkRow,SearchChunkTrailer,SearchResponse>
-
-
Constructor Summary
Constructors Constructor Description SearchRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, String indexName, byte[] content, RequestSpan span)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchResponse
decode(ResponseStatus status, SearchChunkHeader header, Flux<SearchChunkRow> rows, Mono<SearchChunkTrailer> 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
name()
The unique name of the request, usually related to the type but not necessarily.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, timeoutRegistration
-
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, bucket, cancel, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, operationId, requestSpan, response, retryStrategy, succeed, succeeded, target, timeout, timeoutElapsed, timeoutRegistration
-
-
-
-
Constructor Detail
-
SearchRequest
public SearchRequest(Duration timeout, CoreContext ctx, RetryStrategy retryStrategy, Authenticator authenticator, String indexName, byte[] content, RequestSpan span)
-
-
Method Detail
-
encode
public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()
-
serviceType
public ServiceType serviceType()
Description copied from interface:Request
The service type of this request.- Specified by:
serviceType
in interfaceRequest<SearchResponse>
- Returns:
- the service type for this request.
-
decode
public SearchResponse decode(ResponseStatus status, SearchChunkHeader header, Flux<SearchChunkRow> rows, Mono<SearchChunkTrailer> trailer)
Description copied from interface:ChunkDecodable
Decodes a chunked response into the response format.- Specified by:
decode
in interfaceChunkDecodable<SearchChunkHeader,SearchChunkRow,SearchChunkTrailer,SearchResponse>
- 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.
-
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<SearchResponse>
- 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 interfaceRequest<SearchResponse>
- Overrides:
serviceContext
in classBaseRequest<SearchResponse>
- Returns:
- the service context.
-
name
public String name()
Description copied from interface:Request
The unique name of the request, usually related to the type but not necessarily.The default implementation is derived from the class name (i.e. FooRequest => foo), but if that does not match up it should be overridden in the actual class.
- Specified by:
name
in interfaceRequest<SearchResponse>
- Returns:
- the name of the request type.
-
-