io.kubernetes.client.openapi.models.V1ConfigMapVolumeSource Maven / Gradle / Ivy
The newest version!
/*
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 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.V1KeyToPath;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
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.Set;
import io.kubernetes.client.openapi.JSON;
/**
* Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.
*/
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-04T19:37:38.574271Z[Etc/UTC]", comments = "Generator version: 7.6.0")
public class V1ConfigMapVolumeSource {
public static final String SERIALIZED_NAME_DEFAULT_MODE = "defaultMode";
@SerializedName(SERIALIZED_NAME_DEFAULT_MODE)
private Integer defaultMode;
public static final String SERIALIZED_NAME_ITEMS = "items";
@SerializedName(SERIALIZED_NAME_ITEMS)
private List items = new ArrayList<>();
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_OPTIONAL = "optional";
@SerializedName(SERIALIZED_NAME_OPTIONAL)
private Boolean optional;
public V1ConfigMapVolumeSource() {
}
public V1ConfigMapVolumeSource defaultMode(Integer defaultMode) {
this.defaultMode = defaultMode;
return this;
}
/**
* defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
* @return defaultMode
**/
@jakarta.annotation.Nullable
public Integer getDefaultMode() {
return defaultMode;
}
public void setDefaultMode(Integer defaultMode) {
this.defaultMode = defaultMode;
}
public V1ConfigMapVolumeSource items(List items) {
this.items = items;
return this;
}
public V1ConfigMapVolumeSource addItemsItem(V1KeyToPath itemsItem) {
if (this.items == null) {
this.items = new ArrayList<>();
}
this.items.add(itemsItem);
return this;
}
/**
* items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'.
* @return items
**/
@jakarta.annotation.Nullable
public List getItems() {
return items;
}
public void setItems(List items) {
this.items = items;
}
public V1ConfigMapVolumeSource name(String name) {
this.name = name;
return this;
}
/**
* Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
* @return name
**/
@jakarta.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public V1ConfigMapVolumeSource optional(Boolean optional) {
this.optional = optional;
return this;
}
/**
* optional specify whether the ConfigMap or its keys must be defined
* @return optional
**/
@jakarta.annotation.Nullable
public Boolean getOptional() {
return optional;
}
public void setOptional(Boolean optional) {
this.optional = optional;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
V1ConfigMapVolumeSource v1ConfigMapVolumeSource = (V1ConfigMapVolumeSource) o;
return Objects.equals(this.defaultMode, v1ConfigMapVolumeSource.defaultMode) &&
Objects.equals(this.items, v1ConfigMapVolumeSource.items) &&
Objects.equals(this.name, v1ConfigMapVolumeSource.name) &&
Objects.equals(this.optional, v1ConfigMapVolumeSource.optional);
}
@Override
public int hashCode() {
return Objects.hash(defaultMode, items, name, optional);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class V1ConfigMapVolumeSource {\n");
sb.append(" defaultMode: ").append(toIndentedString(defaultMode)).append("\n");
sb.append(" items: ").append(toIndentedString(items)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" optional: ").append(toIndentedString(optional)).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("defaultMode");
openapiFields.add("items");
openapiFields.add("name");
openapiFields.add("optional");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* Validates the JSON Element and throws an exception if issues found
*
* @param jsonElement JSON Element
* @throws IOException if the JSON Element is invalid with respect to V1ConfigMapVolumeSource
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!V1ConfigMapVolumeSource.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in V1ConfigMapVolumeSource is not found in the empty JSON string", V1ConfigMapVolumeSource.openapiRequiredFields.toString()));
}
}
Set> entries = jsonElement.getAsJsonObject().entrySet();
// check to see if the JSON string contains additional fields
for (Map.Entry entry : entries) {
if (!V1ConfigMapVolumeSource.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `V1ConfigMapVolumeSource` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if (jsonObj.get("items") != null && !jsonObj.get("items").isJsonNull()) {
JsonArray jsonArrayitems = jsonObj.getAsJsonArray("items");
if (jsonArrayitems != null) {
// ensure the json data is an array
if (!jsonObj.get("items").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `items` to be an array in the JSON string but got `%s`", jsonObj.get("items").toString()));
}
// validate the optional field `items` (array)
for (int i = 0; i < jsonArrayitems.size(); i++) {
V1KeyToPath.validateJsonElement(jsonArrayitems.get(i));
};
}
}
if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!V1ConfigMapVolumeSource.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'V1ConfigMapVolumeSource' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(V1ConfigMapVolumeSource.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, V1ConfigMapVolumeSource value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public V1ConfigMapVolumeSource read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
return thisAdapter.fromJsonTree(jsonElement);
}
}.nullSafe();
}
}
/**
* Create an instance of V1ConfigMapVolumeSource given an JSON string
*
* @param jsonString JSON string
* @return An instance of V1ConfigMapVolumeSource
* @throws IOException if the JSON string is invalid with respect to V1ConfigMapVolumeSource
*/
public static V1ConfigMapVolumeSource fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, V1ConfigMapVolumeSource.class);
}
/**
* Convert an instance of V1ConfigMapVolumeSource to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}