io.fabric8.kubernetes.client.dsl.Waitable Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2015 Red Hat, 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 io.fabric8.kubernetes.client.dsl;

import java.util.concurrent.TimeUnit;
import java.util.function.Predicate;

public interface Waitable {

  /**
   * @deprecated no longer used
   */
  @Deprecated
  long DEFAULT_INITIAL_BACKOFF_MILLIS = 5L;
  /**
   * @deprecated no longer used
   */
  @Deprecated
  double DEFAULT_BACKOFF_MULTIPLIER = 2d;

  T waitUntilReady(long amount, TimeUnit timeUnit);

  T waitUntilCondition(Predicate condition, long amount, TimeUnit timeUnit);

  /**
   * Configure the backoff strategy to use when waiting for conditions, in case the watcher encounters a retryable error.
   * @param initialBackoff the value for the initial backoff on first error
   * @param backoffUnit the TimeUnit for the initial backoff value
   * @param backoffMultiplier what to multiply the backoff by on each subsequent error
   * @return the waitable
   * @deprecated no longer used
   */
  @Deprecated
  Waitable withWaitRetryBackoff(long initialBackoff, TimeUnit backoffUnit, double backoffMultiplier);
}