com.couchbase.client.core.endpoint.http

Class CoreHttpRequest.Builder

java.lang.Object

com.couchbase.client.core.endpoint.http.CoreHttpRequest.Builder

Enclosing class:

CoreHttpRequest

@Stability.Internal
public static class CoreHttpRequest.Builder
extends Object

Builder for dynamic HTTP requests

Constructor Summary

Constructors

Constructor and Description
Builder(CoreCommonOptions options, CoreContext coreContext, RequestTarget target, com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpMethod method, CoreHttpPath path)

Method Summary

Modifier and Type	Method and Description
CoreHttpRequest	build()
CoreHttpRequest.Builder	bypassExceptionTranslation(boolean bypass) If true, a non-2xx HTTP status codes is always reported as an HttpStatusCodeException.
CoreHttpRequest.Builder	content(byte[] content, CharSequence contentType)
CompletableFuture<CoreHttpResponse>	exec(Core core)
CoreHttpRequest.Builder	form(UrlQueryStringBuilder formData)
CoreHttpRequest.Builder	header(CharSequence name, Object value)
CoreHttpRequest.Builder	idempotent(boolean idempotent)
CoreHttpRequest.Builder	json(byte[] content)
static UrlQueryStringBuilder	newForm()
static UrlQueryStringBuilder	newQueryString()
CoreHttpRequest.Builder	queryString(String preEncodedQueryString)
CoreHttpRequest.Builder	queryString(UrlQueryStringBuilder queryString)
CoreHttpRequest.Builder	trace(String spanName)
CoreHttpRequest.Builder	traceAttr(String attributeName, Object attributeValue)
CoreHttpRequest.Builder	traceBucket(String bucketName)
CoreHttpRequest.Builder	traceCollection(String collectionName)
CoreHttpRequest.Builder	traceScope(String scopeName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(CoreCommonOptions options,
               CoreContext coreContext,
               RequestTarget target,
               com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpMethod method,
               CoreHttpPath path)

Method Detail

newForm

public static UrlQueryStringBuilder newForm()

newQueryString

public static UrlQueryStringBuilder newQueryString()

trace

public CoreHttpRequest.Builder trace(String spanName)

Parameters:

spanName - (nullable)

traceAttr

public CoreHttpRequest.Builder traceAttr(String attributeName,
                                         Object attributeValue)

traceBucket

public CoreHttpRequest.Builder traceBucket(String bucketName)

traceScope

public CoreHttpRequest.Builder traceScope(String scopeName)

traceCollection

public CoreHttpRequest.Builder traceCollection(String collectionName)

header

public CoreHttpRequest.Builder header(CharSequence name,
                                      Object value)

idempotent

public CoreHttpRequest.Builder idempotent(boolean idempotent)

queryString

public CoreHttpRequest.Builder queryString(UrlQueryStringBuilder queryString)

queryString

public CoreHttpRequest.Builder queryString(String preEncodedQueryString)

bypassExceptionTranslation

public CoreHttpRequest.Builder bypassExceptionTranslation(boolean bypass)

If true, a non-2xx HTTP status codes is always reported as an HttpStatusCodeException. If false, the message handler may throw a domain-specific exception instead.

Defaults to false.

See Also:

NonChunkedHttpRequest.bypassExceptionTranslation()

form

public CoreHttpRequest.Builder form(UrlQueryStringBuilder formData)

json

public CoreHttpRequest.Builder json(byte[] content)

content

public CoreHttpRequest.Builder content(byte[] content,
                                       CharSequence contentType)

build

public CoreHttpRequest build()

exec

public CompletableFuture<CoreHttpResponse> exec(Core core)