com.marcnuri.yakc.apiextensions.ExtendedCoreV1Api Maven / Gradle / Ivy

Go to download

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

Retrofit2 based Java interfaces to create a declarative REST API client for Kubernetes.

There is a newer version: 0.0.28

/*
 * Copyright 2020 Marc Nuri
 *
 * 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.marcnuri.yakc.apiextensions;

import com.marcnuri.yakc.api.KubernetesExecCall;
import com.marcnuri.yakc.api.core.v1.CoreV1Api;
import retrofit2.http.HTTP;
import retrofit2.http.Headers;
import retrofit2.http.Path;
import retrofit2.http.Query;

import java.util.List;

/**
 * Created by Marc Nuri on 2020-04-27.
 */
public interface ExtendedCoreV1Api extends CoreV1Api {
  /**
   * Execute a command in the only container of the Pod with the provided name in the provided namespace.
   *
   * @param name name of the Pod.
   * @param namespace namespace where the Pod resides.
   * @param commands the command and args to execute in the Pod container.
   */
  @HTTP(
    method = "GET",
    path = "/api/v1/namespaces/{namespace}/pods/{name}/exec"
  )
  @Headers({
    "Accept: */*"
  })
  KubernetesExecCall execInNamespacedPod(
    @Path("name") String name,
    @Path("namespace") String namespace,
    @Query("command") List commands);

  /**
   * Execute a command in the provided container of the Pod with the provided name in the provided namespace.
   *
   * @param name name of the Pod.
   * @param namespace namespace where the Pod resides.
   * @param container the name of the container.
   * @param commands the command and args to execute in the Pod container.
   */
  @HTTP(
    method = "GET",
    path = "/api/v1/namespaces/{namespace}/pods/{name}/exec"
  )
  @Headers({
    "Accept: */*"
  })
  KubernetesExecCall execInNamespacedPod(
    @Path("name") String name,
    @Path("namespace") String namespace,
    @Query("container") String container,
    @Query("command") List commands);
}