case class DecrementOptions(initial: Option[Long] = None, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = null, expiryTime: Option[Instant] = None) extends Product with Serializable
Provides control over how an decrement operation is performed.
- Alphabetic
- By Inheritance
- DecrementOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DecrementOptions(initial: Option[Long] = None, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = null, expiryTime: Option[Instant] = None)
Value Members
- def durability(value: Durability): DecrementOptions
Changes the durability setting used for this operation.
Changes the durability setting used for this operation.
Writes in Couchbase are written to a single node, and from there the Couchbase Server will take care of sending that mutation to any configured replicas. This parameter provides some control over ensuring the success of the mutation's replication. See com.couchbase.client.scala.durability.Durability.
If not specified, it defaults to com.couchbase.client.scala.durability.Durability.Disabled.
- returns
a copy of this with the change applied, for chaining.
- def expiry(value: Instant): DecrementOptions
Changes the expiry setting used for this operation.
Changes the expiry setting used for this operation.
This overload should be used for any expiration times >= 30 days. If below that, use the overload that takes a
Durationinstead.Couchbase documents optionally can have an expiration field set, e.g. when they will automatically expire and be removed. On mutations if this is left at the default (0), then any expiry will be removed and the document will never expire. If the application wants to preserve expiration then they should use the
withExpirationparameter on any gets, and provide the returned expiration parameter to any mutations.- returns
a copy of this with the change applied, for chaining.
- def expiry(value: Option[Duration]): DecrementOptions
Changes the expiry setting used for this operation.
Changes the expiry setting used for this operation.
This overload should be used for any expiration times < 30 days. If over that, use the overload that takes an
Instantinstead.Couchbase documents optionally can have an expiration field set, e.g. when they will automatically expire and be removed. On mutations if this is left at the default (null), then any expiry will be removed and the document will never expire. If the application wants to preserve expiration then they should use the
withExpirationparameter on any gets, and provide the returned expiration parameter to any mutations.This Option-overload is provided as a convenience to help with chaining.
- returns
a copy of this with the change applied, for chaining.
- def expiry(value: Duration): DecrementOptions
Changes the expiry setting used for this operation.
Changes the expiry setting used for this operation.
This overload should be used for any expiration times < 30 days. If over that, use the overload that takes an
Instantinstead.Couchbase documents optionally can have an expiration field set, e.g. when they will automatically expire and be removed. On mutations if this is left at the default (null), then any expiry will be removed and the document will never expire. If the application wants to preserve expiration then they should use the
withExpirationparameter on any gets, and provide the returned expiration parameter to any mutations.- returns
a copy of this with the change applied, for chaining.
- def initial(value: Long): DecrementOptions
The amount to initialise the document too, if it does not exist.
The amount to initialise the document too, if it does not exist. If this is not set, and the document does not exist, Failure(DocumentDoesNotExistException) will be returned
- returns
a copy of this with the change applied, for chaining.
- def parentSpan(value: Option[RequestSpan]): DecrementOptions
Changes the parent span setting used for this operation.
Changes the parent span setting used for this operation.
This allows tracing requests through a full distributed system.
This Option-overload is provided as a convenience to help with chaining.
- returns
a copy of this with the change applied, for chaining.
- Annotations
- @Volatile()
- def parentSpan(value: RequestSpan): DecrementOptions
Changes the parent span setting used for this operation.
Changes the parent span setting used for this operation.
This allows tracing requests through a full distributed system.
- returns
a copy of this with the change applied, for chaining.
- Annotations
- @Volatile()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def retryStrategy(value: RetryStrategy): DecrementOptions
Provides some control over how the SDK handles failures.
Provides some control over how the SDK handles failures. Will default to
retryStrategy()in the provided com.couchbase.client.scala.env.ClusterEnvironment, which by default isBestEffortRetryStrategy; this will automatically retry some operations (e.g. non-mutating ones, or mutating operations that have unambiguously failed before they mutated state) until the chosen timeout.- returns
a copy of this with the change applied, for chaining.
- def timeout(value: Duration): DecrementOptions
Changes the timeout setting used for this operation.
Changes the timeout setting used for this operation.
When the operation will timeout. This will default to
timeoutConfig().kvTimeout()in the com.couchbase.client.scala.env.ClusterEnvironment.- returns
a copy of this with the change applied, for chaining.