case class IncrementOptions(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 increment operation is performed.
- Alphabetic
- By Inheritance
- IncrementOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new IncrementOptions(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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def durability(value: Durability): IncrementOptions
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.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def expiry(value: Instant): IncrementOptions
Changes the expiry setting used for this operation.
Changes the expiry setting used for this operation.
CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.
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]): IncrementOptions
Changes the expiry setting used for this operation.
Changes the expiry setting used for this operation.
CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.
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.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): IncrementOptions
Changes the expiry setting used for this operation.
Changes the expiry setting used for this operation.
CAVEAT: If the counter document already exists, this option is ignored and the document's current expiry is preserved.
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.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def initial(value: Long): IncrementOptions
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.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def parentSpan(value: Option[RequestSpan]): IncrementOptions
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.
- def parentSpan(value: RequestSpan): IncrementOptions
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.
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def retryStrategy(value: RetryStrategy): IncrementOptions
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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeout(value: Duration): IncrementOptions
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.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)