Package 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,CommonHttpOptions,ConnectLinkAnalyticsOptions,CreateBucketOptions,CreateCollectionOptions,CreateDatasetAnalyticsOptions,CreateDataverseAnalyticsOptions,CreateIndexAnalyticsOptions,CreateLinkAnalyticsOptions,CreatePrimaryQueryIndexOptions,CreateQueryIndexOptions,CreateScopeOptions,DeployFunctionOptions,DisallowQueryingSearchIndexOptions,DisconnectLinkAnalyticsOptions,DropBucketOptions,DropCollectionOptions,DropDatasetAnalyticsOptions,DropDataverseAnalyticsOptions,DropDesignDocumentOptions,DropFunctionOptions,DropGroupOptions,DropIndexAnalyticsOptions,DropLinkAnalyticsOptions,DropPrimaryQueryIndexOptions,DropQueryIndexOptions,DropScopeOptions,DropSearchIndexOptions,DropUserOptions,ExistsOptions,FlushBucketOptions,FreezePlanSearchIndexOptions,FunctionsStatusOptions,GetAllBucketOptions,GetAllDatasetsAnalyticsOptions,GetAllDataversesAnalyticsOptions,GetAllDesignDocumentsOptions,GetAllFunctionsOptions,GetAllGroupsOptions,GetAllIndexesAnalyticsOptions,GetAllQueryIndexesOptions,GetAllReplicasOptions,GetAllScopesOptions,GetAllSearchIndexesOptions,GetAllUsersOptions,GetAndLockOptions,GetAndTouchOptions,GetAnyReplicaOptions,GetBucketOptions,GetDesignDocumentOptions,GetFunctionOptions,GetGroupOptions,GetIndexedSearchIndexOptions,GetLinksAnalyticsOptions,GetOptions,GetPendingMutationsAnalyticsOptions,GetRolesOptions,GetScopeOptions,GetSearchIndexOptions,GetUserOptions,LookupInOptions,PauseFunctionOptions,PauseIngestSearchIndexOptions,PublishDesignDocumentOptions,QueryOptions,RawManagerOptions,ReplaceLinkAnalyticsOptions,ResumeFunctionOptions,ResumeIngestSearchIndexOptions,SearchOptions,TouchOptions,UndeployFunctionOptions,UnfreezePlanSearchIndexOptions,UnlockOptions,UpdateBucketOptions,UpsertDesignDocumentOptions,UpsertFunctionOptions,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 Description classCommonOptions.BuiltCommonOptions
-
Constructor Summary
Constructors Constructor Description CommonOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SELFclientContext(Map<String,Object> clientContext)Specifies custom, client domain specific context metadata with this operation.SELFparentSpan(RequestSpan parentSpan)Allows to specify a parent span that should be used on top of this request.SELFretryStrategy(RetryStrategy retryStrategy)Specifies a customRetryStrategyfor this operation.protected SELFself()Allows to return the right options builder instance for child implementations.SELFtimeout(Duration timeout)Specifies a custom per-operation timeout.
-
-
-
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 customRetryStrategyfor 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
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.
-
-