io.kubernetes.client.openapi.models.V1HTTPIngressPath Maven / Gradle / Ivy
/*
Copyright 2024 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.openapi.models;
import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.kubernetes.client.openapi.models.V1IngressBackend;
import java.io.IOException;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import io.kubernetes.client.openapi.JSON;
/**
* HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.
*/
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-04-23T13:45:09.091597Z[Etc/UTC]")
public class V1HTTPIngressPath {
public static final String SERIALIZED_NAME_BACKEND = "backend";
@SerializedName(SERIALIZED_NAME_BACKEND)
private V1IngressBackend backend;
public static final String SERIALIZED_NAME_PATH = "path";
@SerializedName(SERIALIZED_NAME_PATH)
private String path;
public static final String SERIALIZED_NAME_PATH_TYPE = "pathType";
@SerializedName(SERIALIZED_NAME_PATH_TYPE)
private String pathType;
public V1HTTPIngressPath() {
}
public V1HTTPIngressPath backend(V1IngressBackend backend) {
this.backend = backend;
return this;
}
/**
* Get backend
* @return backend
**/
@jakarta.annotation.Nonnull
public V1IngressBackend getBackend() {
return backend;
}
public void setBackend(V1IngressBackend backend) {
this.backend = backend;
}
public V1HTTPIngressPath path(String path) {
this.path = path;
return this;
}
/**
* path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional \"path\" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value \"Exact\" or \"Prefix\".
* @return path
**/
@jakarta.annotation.Nullable
public String getPath() {
return path;
}
public void setPath(String path) {
this.path = path;
}
public V1HTTPIngressPath pathType(String pathType) {
this.pathType = pathType;
return this;
}
/**
* pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.
* @return pathType
**/
@jakarta.annotation.Nonnull
public String getPathType() {
return pathType;
}
public void setPathType(String pathType) {
this.pathType = pathType;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
V1HTTPIngressPath v1HTTPIngressPath = (V1HTTPIngressPath) o;
return Objects.equals(this.backend, v1HTTPIngressPath.backend) &&
Objects.equals(this.path, v1HTTPIngressPath.path) &&
Objects.equals(this.pathType, v1HTTPIngressPath.pathType);
}
@Override
public int hashCode() {
return Objects.hash(backend, path, pathType);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class V1HTTPIngressPath {\n");
sb.append(" backend: ").append(toIndentedString(backend)).append("\n");
sb.append(" path: ").append(toIndentedString(path)).append("\n");
sb.append(" pathType: ").append(toIndentedString(pathType)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("backend");
openapiFields.add("path");
openapiFields.add("pathType");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("backend");
openapiRequiredFields.add("pathType");
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to V1HTTPIngressPath
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!V1HTTPIngressPath.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in V1HTTPIngressPath is not found in the empty JSON string", V1HTTPIngressPath.openapiRequiredFields.toString()));
}
}
Set> entries = jsonObj.entrySet();
// check to see if the JSON string contains additional fields
for (Entry entry : entries) {
if (!V1HTTPIngressPath.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `V1HTTPIngressPath` properties. JSON: %s", entry.getKey(), jsonObj.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : V1HTTPIngressPath.openapiRequiredFields) {
if (jsonObj.get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonObj.toString()));
}
}
// validate the required field `backend`
V1IngressBackend.validateJsonObject(jsonObj.getAsJsonObject("backend"));
if ((jsonObj.get("path") != null && !jsonObj.get("path").isJsonNull()) && !jsonObj.get("path").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `path` to be a primitive type in the JSON string but got `%s`", jsonObj.get("path").toString()));
}
if (!jsonObj.get("pathType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `pathType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("pathType").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!V1HTTPIngressPath.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'V1HTTPIngressPath' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(V1HTTPIngressPath.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, V1HTTPIngressPath value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public V1HTTPIngressPath read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
return thisAdapter.fromJsonTree(jsonObj);
}
}.nullSafe();
}
}
/**
* Create an instance of V1HTTPIngressPath given an JSON string
*
* @param jsonString JSON string
* @return An instance of V1HTTPIngressPath
* @throws IOException if the JSON string is invalid with respect to V1HTTPIngressPath
*/
public static V1HTTPIngressPath fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, V1HTTPIngressPath.class);
}
/**
* Convert an instance of V1HTTPIngressPath to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}