Packages

case class PingOptions(serviceTypes: Set[ServiceType] = PingOptions.AllServiceTypes, reportId: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PingOptions
  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 PingOptions(serviceTypes: Set[ServiceType] = PingOptions.AllServiceTypes, reportId: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = 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(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  11. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. def reportId(value: String): PingOptions

    Sets a report ID that will be returned in the com.couchbase.client.core.diagnostics.PingResult.

    Sets a report ID that will be returned in the com.couchbase.client.core.diagnostics.PingResult.

    It defaults to a random string

    returns

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

  14. val reportId: Option[String]
  15. def retryStrategy(value: RetryStrategy): PingOptions

    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.

  16. val retryStrategy: Option[RetryStrategy]
  17. def serviceTypes(value: Set[ServiceType]): PingOptions

    Changes the services that will be pinged.

    Changes the services that will be pinged.

    The default is an empty set, which will cause all services to be pinged.

    returns

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

  18. val serviceTypes: Set[ServiceType]
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def timeout(value: Duration): PingOptions

    Changes the timeout setting used for this operation.

    Changes the timeout setting used for this operation.

    returns

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

  21. val timeout: Option[Duration]
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped