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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kubernetes-client-api Show documentation

There is a newer version: 7.1.0

Show newest version

/*
 * 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 {

  /**
   * For resources other than Node, Deployment, ReplicaSet, StatefulSet, Pod, ReplicationController, and DeploymentConfig
   * readiness is simply an existence check.
   * 

   * Consider using the more general {@link #waitUntilCondition(Predicate, long, TimeUnit)} when dealing with
   * more complex situations or other types.
   */
  T waitUntilReady(long amount, TimeUnit timeUnit);

  /**
   * Wait for the given condition to be true.
   * 
   * The processing of events will be in the IO thread, blocking operations should be avoided.
   * 

   * If nothing exists, the condition will be tested with a null value.
   *
   * @param condition
   * @param amount
   * @param timeUnit
   * @return the result that passes the given condition
   */
  T waitUntilCondition(Predicate condition, long amount, TimeUnit timeUnit);

}