com.couchbase.client.java

Class CommonOptions<SELF extends CommonOptions<SELF>>

java.lang.Object

com.couchbase.client.java.CommonOptions<SELF>

Direct Known Subclasses:

AllowQueryingSearchIndexOptions, AnalyticsOptions, AnalyzeDocumentOptions, BuildQueryIndexOptions, CommonDatastructureOptions, CommonDurabilityOptions, ConnectLinkAnalyticsOptions, CreateBucketOptions, CreateCollectionOptions, CreateDatasetAnalyticsOptions, CreateDataverseAnalyticsOptions, CreateIndexAnalyticsOptions, CreatePrimaryQueryIndexOptions, CreateQueryIndexOptions, CreateScopeOptions, DisallowQueryingSearchIndexOptions, DisconnectLinkAnalyticsOptions, DropBucketOptions, DropCollectionOptions, DropDatasetAnalyticsOptions, DropDataverseAnalyticsOptions, DropDesignDocumentOptions, DropGroupOptions, DropIndexAnalyticsOptions, DropPrimaryQueryIndexOptions, DropQueryIndexOptions, DropScopeOptions, DropSearchIndexOptions, DropUserOptions, ExistsOptions, FlushBucketOptions, FreezePlanSearchIndexOptions, GetAllBucketOptions, GetAllDatasetsAnalyticsOptions, GetAllDesignDocumentsOptions, GetAllGroupsOptions, GetAllIndexesAnalyticsOptions, GetAllQueryIndexesOptions, GetAllReplicasOptions, GetAllScopesOptions, GetAllSearchIndexesOptions, GetAllUsersOptions, GetAndLockOptions, GetAndTouchOptions, GetAnyReplicaOptions, GetBucketOptions, GetDesignDocumentOptions, GetGroupOptions, GetIndexedSearchIndexOptions, GetOptions, GetPendingMutationsAnalyticsOptions, GetRolesOptions, GetScopeOptions, GetSearchIndexOptions, GetUserOptions, LookupInOptions, PauseIngestSearchIndexOptions, PublishDesignDocumentOptions, QueryOptions, ResumeIngestSearchIndexOptions, SearchOptions, TouchOptions, UnfreezePlanSearchIndexOptions, UnlockOptions, UpdateBucketOptions, UpsertDesignDocumentOptions, UpsertGroupOptions, UpsertSearchIndexOptions, UpsertUserOptions, ViewOptions

public abstract class CommonOptions<SELF extends CommonOptions<SELF>>
extends Object

Common options that are used by most operations.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommonOptions.BuiltCommonOptions

Constructor Summary

Constructors

Constructor and Description
CommonOptions()

Method Summary

Modifier and Type	Method and Description
SELF	clientContext(Map<String,Object> clientContext) Specifies custom, client domain specific context metadata with this operation.
SELF	parentSpan(RequestSpan parentSpan) Allows to specify a parent span that should be used on top of this request.
SELF	retryStrategy(RetryStrategy retryStrategy) Specifies a custom RetryStrategy for this operation.
protected SELF	self() Allows to return the right options builder instance for child implementations.
SELF	timeout(Duration timeout) Specifies a custom per-operation timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonOptions

public CommonOptions()

Method Detail

self

protected SELF self()

Allows to return the right options builder instance for child implementations.

timeout

public SELF timeout(Duration timeout)

Specifies a custom per-operation timeout.

Note: if a custom timeout is provided through this builder, it will override the default set on the environment.

Parameters:

timeout - the timeout to use for this operation.

Returns:

this options builder for chaining purposes.

retryStrategy

public SELF retryStrategy(RetryStrategy retryStrategy)

Specifies a custom RetryStrategy for this operation.

Note: if a custom strategy is provided through this builder, it will override the default set on the environment.

Parameters:

retryStrategy - the retry strategy to use for this operation.

Returns:

this options builder for chaining purposes.

clientContext

public SELF clientContext(Map<String,Object> clientContext)

Specifies custom, client domain specific context metadata with this operation.

Parameters:

clientContext - the client context information as a map.

Returns:

this options builder for chaining purposes.

parentSpan

@Stability.Volatile
public SELF parentSpan(RequestSpan parentSpan)

Allows to specify a parent span that should be used on top of this request.

Note that this only has impact when using a tracing implementation that can actually deal with the notion of a parent. You likely want to use this if you want to wire up your application with OpenTracing or OpenTelemetry - use the support separate modules for that.

IMPORTANT: this is a volatile, likely to change API!

Parameters:

parentSpan - the parent span for this request.

Returns:

this options builder for chaining purposes.