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. def productElementNames: Iterator[String]
    Definition Classes
    Product
  2. 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.

  3. val reportId: Option[String]
  4. 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.

  5. val retryStrategy: Option[RetryStrategy]
  6. 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.

  7. val serviceTypes: Set[ServiceType]
  8. 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.

  9. val timeout: Option[Duration]