com.couchbase.client.scala.diagnostics.WaitUntilReadyOptions.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scala-client_2.12 Show documentation

The official Couchbase Scala SDK

There is a newer version: 1.7.5

/*
 * Copyright (c) 2020 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.couchbase.client.scala.diagnostics

import com.couchbase.client.core.diagnostics.ClusterState
import com.couchbase.client.core.service.ServiceType

case class WaitUntilReadyOptions(
    serviceTypes: Set[ServiceType] = WaitUntilReadyOptions.AllServiceTypes,
    desiredState: ClusterState = ClusterState.ONLINE
) {

  /** The cluster state to wait for, usually ONLINE.
    *
    * Defaults to ONLINE.
    *
    * @return a copy of this with the change applied, for chaining.
    */
  def desiredState(value: ClusterState): WaitUntilReadyOptions = {
    copy(desiredState = value)
  }

  /** Changes the services that will be pinged.
    *
    * The default is an empty set, which will cause all services to be pinged.
    *
    * @return a copy of this with the change applied, for chaining.
    */
  def serviceTypes(value: Set[ServiceType]): WaitUntilReadyOptions = {
    copy(serviceTypes = value)
  }
}

object WaitUntilReadyOptions {
  private[scala] val AllServiceTypes = Set.empty[ServiceType]
}