c

com.couchbase.client.scala.kv

DecrementOptions

case class DecrementOptions(initial: Option[Long] = None, 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 decrement operation is performed.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DecrementOptions
  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 DecrementOptions(initial: Option[Long] = None, durability: Durability = Disabled, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, expiry: Duration = 0.seconds)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. 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.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def expiry(value: Option[Duration]): DecrementOptions

    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.

  9. def expiry(value: Duration): DecrementOptions

    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.

  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. 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.

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. 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()
  18. 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()
  19. 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 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.

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. 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.

  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped