io.kubernetes.client.util.PatchUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of client-java
There is a newer version: 22.0.0
/*
Copyright 2020 The Kubernetes Authors.
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.kubernetes.client.util;

import io.kubernetes.client.openapi.ApiClient;
import io.kubernetes.client.openapi.ApiException;
import io.kubernetes.client.openapi.Configuration;
import okhttp3.Call;
import okhttp3.Request;

/** Provides utility helper functions to send PATCH requests against kubernetes cluster. */
public class PatchUtils {

  /**
   * Patches the resource with the patch format specified.
   *
   * @param  the type parameter
   * @param apiTypeClass the api type class
   * @param callFunc the call func returns a okhttp call object that wraps the http request
   * @param patchFormat the patch format
   * @return the api type
   * @throws ApiException the api exception
   */
  public static  ApiType patch(
      Class apiTypeClass, PatchCallFunc callFunc, String patchFormat) throws ApiException {
    return patch(apiTypeClass, callFunc, patchFormat, Configuration.getDefaultApiClient());
  }

  /**
   * Patches the resource with the patch format and {@link io.kubernetes.client.openapi.ApiClient}
   * specified.
   *
   * @param  the type parameter
   * @param apiTypeClass the api type class
   * @param callFunc the call func returns a okhttp call object that wraps the http request
   * @param patchFormat the patch format
   * @param apiClient the api client
   * @return the api type
   * @throws ApiException the api exception
   */
  public static  ApiType patch(
      Class apiTypeClass, PatchCallFunc callFunc, String patchFormat, ApiClient apiClient)
      throws ApiException {
    Request request = callFunc.getCall().request();
    return apiClient
        .execute(
            apiClient
                .getHttpClient()
                .newCall(
                    callFunc
                        .getCall()
                        .request()
                        .newBuilder()
                        .patch(new ProxyContentTypeRequestBody(request.body(), patchFormat))
                        .build()),
            apiTypeClass)
        .getData();
  }

  /**
   * The Patch call func returns an okhttp call object. This interface is only used for adapting
   * generated openapi client interfaces. e.g. {@link
   * io.kubernetes.client.openapi.apis.CoreV1Api#patchNamespacedPodCall}
   */
  public interface PatchCallFunc {
    /**
     * Gets okhttp call object.
     *
     * @return the call
     * @throws ApiException the api exception
     */
    Call getCall() throws ApiException;
  }
}