c

com.couchbase.client.scala.kv

IncrementOptions

case class IncrementOptions(initial: Option[Long] = None, cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = 0.seconds) extends Product with Serializable

Provides control over how an increment operation is performed.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IncrementOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IncrementOptions(initial: Option[Long] = None, cas: Long = 0, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = 0.seconds)

Value Members

  1. def cas(value: Long): IncrementOptions

    Couchbase documents all have a CAS (Compare-And-Set) field, a simple integer that allows optimistic concurrency - e.g.

    Couchbase documents all have a CAS (Compare-And-Set) field, a simple integer that allows optimistic concurrency - e.g. it can detect if another agent has modified a document in-between this agent getting and modifying the document.

    The default is 0, which disables CAS checking. *

    returns

    a copy of this with the change applied, for chaining.

  2. 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.

  3. def expiry(value: Option[Duration]): IncrementOptions

    Changes the expiry setting used for this operation.

    Changes the expiry setting used for this operation.

    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 withExpiration parameter 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.

  4. def expiry(value: Duration): IncrementOptions

    Changes the expiry setting used for this operation.

    Changes the expiry setting used for this operation.

    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 withExpiration parameter on any gets, and provide the returned expiration parameter to any mutations.

    returns

    a copy of this with the change applied, for chaining.

  5. 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.

  6. 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.

    Annotations
    @Volatile()
  7. 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.

    Annotations
    @Volatile()
  8. 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 is BestEffortRetryStrategy; 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.

  9. 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.