@Stability.Internal public class CoreHttpRequest extends BaseRequest<CoreHttpResponse> implements NonChunkedHttpRequest<CoreHttpResponse>
| Modifier and Type | Class and Description |
|---|---|
static class |
CoreHttpRequest.Builder
Builder for dynamic HTTP requests
|
| Modifier and Type | Method and Description |
|---|---|
String |
bucket()
Returns the name of the bucket this request is scoped to, or null if not scoped to a bucket.
|
static CoreHttpRequest.Builder |
builder(CoreCommonOptions options,
CoreContext coreContext,
com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpMethod method,
CoreHttpPath path,
RequestTarget target) |
boolean |
bypassExceptionTranslation()
If true, a non-2xx HTTP status code must be reported as an
HttpStatusCodeException. |
CoreHttpResponse |
decode(com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpResponse response,
HttpChannelContext channelContext) |
com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest |
encode() |
CompletableFuture<CoreHttpResponse> |
exec(Core core) |
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.
|
NodeIdentifier |
target()
Returns the node that should service this request, or null to let the service locator decide.
|
String |
toString() |
absoluteTimeout, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed, timeoutRegistrationclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitabsoluteTimeout, cancel, cancel, cancellationReason, cancelled, completed, context, createdAt, fail, failed, id, operationId, requestSpan, response, retryStrategy, succeed, succeeded, timeout, timeoutElapsed, timeoutRegistrationpublic static CoreHttpRequest.Builder builder(CoreCommonOptions options, CoreContext coreContext, com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpMethod method, CoreHttpPath path, RequestTarget target)
public String name()
RequestThe default implementation is derived from the class name (i.e. FooRequest returns foo), but if that does not match up it should be overridden in the actual class.
name in interface Request<CoreHttpResponse>public CompletableFuture<CoreHttpResponse> exec(Core core)
public com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpRequest encode()
public CoreHttpResponse decode(com.couchbase.client.core.deps.io.netty.handler.codec.http.FullHttpResponse response, HttpChannelContext channelContext)
decode in interface NonChunkedHttpRequest<CoreHttpResponse>public ServiceType serviceType()
RequestCan be null if this is a 'virtual service' (e.g. transactions), which don't map 1:1 to a particular cluster service, but need to integrate into various codepaths that are built around ServiceType such as ThresholdLoggingTracer. Virtual requests must not be sent into core at present, as there is limited support for them.
serviceType in interface Request<CoreHttpResponse>public boolean idempotent()
RequestBy 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!
idempotent in interface Request<CoreHttpResponse>public NodeIdentifier target()
Requesttarget in interface Request<CoreHttpResponse>public String bucket()
Requestbucket in interface Request<CoreHttpResponse>public Map<String,Object> serviceContext()
RequestserviceContext in interface Request<CoreHttpResponse>serviceContext in class BaseRequest<CoreHttpResponse>public boolean bypassExceptionTranslation()
NonChunkedHttpRequestHttpStatusCodeException.
This lets users see the raw HTTP response when making their own HTTP requests with CouchbaseHttpClient.
If false, the message handler may throw a domain-specific exception instead.
bypassExceptionTranslation in interface NonChunkedHttpRequest<CoreHttpResponse>Copyright © 2024 Couchbase, Inc.. All rights reserved.