io.fabric8.kubernetes.client.extension.ExtensibleResource 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.extension;

import io.fabric8.kubernetes.api.model.DeletionPropagation;
import io.fabric8.kubernetes.client.Client;
import io.fabric8.kubernetes.client.KubernetesClientException;
import io.fabric8.kubernetes.client.dsl.Nameable;
import io.fabric8.kubernetes.client.dsl.Resource;
import io.fabric8.kubernetes.client.dsl.TimeoutableScalable;

import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.function.Function;

/**
 * Provides an interface that is usable by the {@link ExtensibleResourceAdapter} that returns
 * a non-specialized value
 */
public interface ExtensibleResource extends Resource, TimeoutableScalable {

  @Override
  ExtensibleResource lockResourceVersion(String resourceVersion);

  @Override
  ExtensibleResource dryRun(boolean isDryRun);

  @Override
  ExtensibleResource withResourceVersion(String resourceVersion);

  @Override
  ExtensibleResource fromServer();

  @Override
  ExtensibleResource withGracePeriod(long gracePeriodSeconds);

  @Override
  ExtensibleResource withPropagationPolicy(DeletionPropagation propagationPolicy);

  @Override
  ExtensibleResource withIndexers(Map>> indexers);

  /**
   * Should be used to obtain a client in the same write context as the given resource
   * - dryRun, DeletionPropagation, etc.
   *
   * @param clazz client type
   * @return the client in the write context
   */
   C inWriteContext(Class clazz);

  @Override
  ExtensibleResource withLimit(Long limit);

  @Override
  ExtensibleResource lockResourceVersion();

  /**
   * Return the current item, which may be null if the resource was created
   * using {@link Nameable#withName(String)}
   *
   * @return the item
   */
  T getItem();

  @Override
  ExtensibleResource fieldValidation(Validation fieldValidation);

  @Override
  ExtensibleResource fieldManager(String manager);

  @Override
  ExtensibleResource forceConflicts();

  @Override
  ExtensibleResource withTimeout(long timeout, TimeUnit unit);

  @Override
  ExtensibleResource unlock();

  @Override
  ExtensibleResource subresource(String subresource);

  @Override
  default ExtensibleResource withTimeoutInMillis(long timeoutInMillis) {
    return withTimeout(timeoutInMillis, TimeUnit.MILLISECONDS);
  }

  @Override
  default T scale(int count) {
    throw new KubernetesClientException("not implemented");
  }

}