case class PingOptions(serviceTypes: Set[ServiceType] = PingOptions.AllServiceTypes, reportId: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None) extends Product with Serializable
- Alphabetic
- By Inheritance
- PingOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PingOptions(serviceTypes: Set[ServiceType] = PingOptions.AllServiceTypes, reportId: Option[String] = None, retryStrategy: Option[RetryStrategy] = None, timeout: Option[Duration] = None)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- 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.
- val reportId: Option[String]
- 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 isBestEffortRetryStrategy
; 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.
- val retryStrategy: Option[RetryStrategy]
- 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.
- val serviceTypes: Set[ServiceType]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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.
- val timeout: Option[Duration]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)