case class GetOptions(withExpiry: Boolean = false, project: Seq[String] = GetOptions.EmptyProject, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None) extends Product with Serializable

Provides control over how a get operation is performed.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GetOptions
  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 GetOptions(withExpiry: Boolean = false, project: Seq[String] = GetOptions.EmptyProject, timeout: Duration = Duration.MinusInf, parentSpan: Option[RequestSpan] = None, retryStrategy: Option[RetryStrategy] = None, transcoder: Option[Transcoder] = None)

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( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. def parentSpan(value: Option[RequestSpan]): GetOptions

    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()
  14. def parentSpan(value: RequestSpan): GetOptions

    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()
  15. def project(value: Seq[String]): GetOptions

    Projection is an advanced feature allowing one or more fields to be fetched from a JSON document, and the results combined into a JsonObject result.

    Projection is an advanced feature allowing one or more fields to be fetched from a JSON document, and the results combined into a JsonObject result.

    It combines the efficiency of a Sub-Document fetch, in that only specific fields need to be retrieved, with the ease-of-handling of a regular fetch, in that the results can be handled as one JSON.

    returns

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

  16. def retryStrategy(value: RetryStrategy): GetOptions

    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.

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def timeout(value: Duration): GetOptions

    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.

  19. def transcoder(value: Transcoder): GetOptions

    Changes the transcoder used for this operation.

    Changes the transcoder used for this operation.

    The transcoder provides control over how JSON is converted and stored on the Couchbase Server.

    If not specified it will default to to transcoder() in the com.couchbase.client.scala.env.ClusterEnvironment.

    This Option-overload is provided as a convenience to help with chaining.

    returns

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

  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. def withExpiry(value: Boolean): GetOptions

    Couchbase documents optionally can have an expiration field set, e.g.

    Couchbase documents optionally can have an expiration field set, e.g. when they will automatically expire. For efficiency reasons, by default the value of this expiration field is not fetched upon getting a document. If expiry is being used, then set this field to true to ensure the expiration is fetched. This will not only make it available in the returned result, but also ensure that the expiry is available to use when mutating the document, to avoid accidentally resetting the expiry to the default of 0.

    returns

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped