case class UnlockOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None) extends Product with Serializable

Provides control over how an unlock operation is performed.

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

Instance Constructors

  1. new UnlockOptions(timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None)

Value Members

  1. def parentSpan(value: Option[RequestSpan]): UnlockOptions

    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.

  2. def parentSpan(value: RequestSpan): UnlockOptions

    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.

  3. def productElementNames: Iterator[String]
    Definition Classes
    Product
  4. def retryStrategy(value: RetryStrategy): UnlockOptions

    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.

  5. def timeout(value: Duration): UnlockOptions

    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.