io.kubernetes.client.openapi.models.V1ISCSIVolumeSource 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.V1LocalObjectReference;
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;
/**
* Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI 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 V1ISCSIVolumeSource {
public static final String SERIALIZED_NAME_CHAP_AUTH_DISCOVERY = "chapAuthDiscovery";
@SerializedName(SERIALIZED_NAME_CHAP_AUTH_DISCOVERY)
private Boolean chapAuthDiscovery;
public static final String SERIALIZED_NAME_CHAP_AUTH_SESSION = "chapAuthSession";
@SerializedName(SERIALIZED_NAME_CHAP_AUTH_SESSION)
private Boolean chapAuthSession;
public static final String SERIALIZED_NAME_FS_TYPE = "fsType";
@SerializedName(SERIALIZED_NAME_FS_TYPE)
private String fsType;
public static final String SERIALIZED_NAME_INITIATOR_NAME = "initiatorName";
@SerializedName(SERIALIZED_NAME_INITIATOR_NAME)
private String initiatorName;
public static final String SERIALIZED_NAME_IQN = "iqn";
@SerializedName(SERIALIZED_NAME_IQN)
private String iqn;
public static final String SERIALIZED_NAME_ISCSI_INTERFACE = "iscsiInterface";
@SerializedName(SERIALIZED_NAME_ISCSI_INTERFACE)
private String iscsiInterface;
public static final String SERIALIZED_NAME_LUN = "lun";
@SerializedName(SERIALIZED_NAME_LUN)
private Integer lun;
public static final String SERIALIZED_NAME_PORTALS = "portals";
@SerializedName(SERIALIZED_NAME_PORTALS)
private List portals = new ArrayList<>();
public static final String SERIALIZED_NAME_READ_ONLY = "readOnly";
@SerializedName(SERIALIZED_NAME_READ_ONLY)
private Boolean readOnly;
public static final String SERIALIZED_NAME_SECRET_REF = "secretRef";
@SerializedName(SERIALIZED_NAME_SECRET_REF)
private V1LocalObjectReference secretRef;
public static final String SERIALIZED_NAME_TARGET_PORTAL = "targetPortal";
@SerializedName(SERIALIZED_NAME_TARGET_PORTAL)
private String targetPortal;
public V1ISCSIVolumeSource() {
}
public V1ISCSIVolumeSource chapAuthDiscovery(Boolean chapAuthDiscovery) {
this.chapAuthDiscovery = chapAuthDiscovery;
return this;
}
/**
* chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
* @return chapAuthDiscovery
**/
@jakarta.annotation.Nullable
public Boolean getChapAuthDiscovery() {
return chapAuthDiscovery;
}
public void setChapAuthDiscovery(Boolean chapAuthDiscovery) {
this.chapAuthDiscovery = chapAuthDiscovery;
}
public V1ISCSIVolumeSource chapAuthSession(Boolean chapAuthSession) {
this.chapAuthSession = chapAuthSession;
return this;
}
/**
* chapAuthSession defines whether support iSCSI Session CHAP authentication
* @return chapAuthSession
**/
@jakarta.annotation.Nullable
public Boolean getChapAuthSession() {
return chapAuthSession;
}
public void setChapAuthSession(Boolean chapAuthSession) {
this.chapAuthSession = chapAuthSession;
}
public V1ISCSIVolumeSource fsType(String fsType) {
this.fsType = fsType;
return this;
}
/**
* fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi
* @return fsType
**/
@jakarta.annotation.Nullable
public String getFsType() {
return fsType;
}
public void setFsType(String fsType) {
this.fsType = fsType;
}
public V1ISCSIVolumeSource initiatorName(String initiatorName) {
this.initiatorName = initiatorName;
return this;
}
/**
* initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume name> will be created for the connection.
* @return initiatorName
**/
@jakarta.annotation.Nullable
public String getInitiatorName() {
return initiatorName;
}
public void setInitiatorName(String initiatorName) {
this.initiatorName = initiatorName;
}
public V1ISCSIVolumeSource iqn(String iqn) {
this.iqn = iqn;
return this;
}
/**
* iqn is the target iSCSI Qualified Name.
* @return iqn
**/
@jakarta.annotation.Nonnull
public String getIqn() {
return iqn;
}
public void setIqn(String iqn) {
this.iqn = iqn;
}
public V1ISCSIVolumeSource iscsiInterface(String iscsiInterface) {
this.iscsiInterface = iscsiInterface;
return this;
}
/**
* iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
* @return iscsiInterface
**/
@jakarta.annotation.Nullable
public String getIscsiInterface() {
return iscsiInterface;
}
public void setIscsiInterface(String iscsiInterface) {
this.iscsiInterface = iscsiInterface;
}
public V1ISCSIVolumeSource lun(Integer lun) {
this.lun = lun;
return this;
}
/**
* lun represents iSCSI Target Lun number.
* @return lun
**/
@jakarta.annotation.Nonnull
public Integer getLun() {
return lun;
}
public void setLun(Integer lun) {
this.lun = lun;
}
public V1ISCSIVolumeSource portals(List portals) {
this.portals = portals;
return this;
}
public V1ISCSIVolumeSource addPortalsItem(String portalsItem) {
if (this.portals == null) {
this.portals = new ArrayList<>();
}
this.portals.add(portalsItem);
return this;
}
/**
* portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
* @return portals
**/
@jakarta.annotation.Nullable
public List getPortals() {
return portals;
}
public void setPortals(List portals) {
this.portals = portals;
}
public V1ISCSIVolumeSource readOnly(Boolean readOnly) {
this.readOnly = readOnly;
return this;
}
/**
* readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
* @return readOnly
**/
@jakarta.annotation.Nullable
public Boolean getReadOnly() {
return readOnly;
}
public void setReadOnly(Boolean readOnly) {
this.readOnly = readOnly;
}
public V1ISCSIVolumeSource secretRef(V1LocalObjectReference secretRef) {
this.secretRef = secretRef;
return this;
}
/**
* Get secretRef
* @return secretRef
**/
@jakarta.annotation.Nullable
public V1LocalObjectReference getSecretRef() {
return secretRef;
}
public void setSecretRef(V1LocalObjectReference secretRef) {
this.secretRef = secretRef;
}
public V1ISCSIVolumeSource targetPortal(String targetPortal) {
this.targetPortal = targetPortal;
return this;
}
/**
* targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
* @return targetPortal
**/
@jakarta.annotation.Nonnull
public String getTargetPortal() {
return targetPortal;
}
public void setTargetPortal(String targetPortal) {
this.targetPortal = targetPortal;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
V1ISCSIVolumeSource v1ISCSIVolumeSource = (V1ISCSIVolumeSource) o;
return Objects.equals(this.chapAuthDiscovery, v1ISCSIVolumeSource.chapAuthDiscovery) &&
Objects.equals(this.chapAuthSession, v1ISCSIVolumeSource.chapAuthSession) &&
Objects.equals(this.fsType, v1ISCSIVolumeSource.fsType) &&
Objects.equals(this.initiatorName, v1ISCSIVolumeSource.initiatorName) &&
Objects.equals(this.iqn, v1ISCSIVolumeSource.iqn) &&
Objects.equals(this.iscsiInterface, v1ISCSIVolumeSource.iscsiInterface) &&
Objects.equals(this.lun, v1ISCSIVolumeSource.lun) &&
Objects.equals(this.portals, v1ISCSIVolumeSource.portals) &&
Objects.equals(this.readOnly, v1ISCSIVolumeSource.readOnly) &&
Objects.equals(this.secretRef, v1ISCSIVolumeSource.secretRef) &&
Objects.equals(this.targetPortal, v1ISCSIVolumeSource.targetPortal);
}
@Override
public int hashCode() {
return Objects.hash(chapAuthDiscovery, chapAuthSession, fsType, initiatorName, iqn, iscsiInterface, lun, portals, readOnly, secretRef, targetPortal);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class V1ISCSIVolumeSource {\n");
sb.append(" chapAuthDiscovery: ").append(toIndentedString(chapAuthDiscovery)).append("\n");
sb.append(" chapAuthSession: ").append(toIndentedString(chapAuthSession)).append("\n");
sb.append(" fsType: ").append(toIndentedString(fsType)).append("\n");
sb.append(" initiatorName: ").append(toIndentedString(initiatorName)).append("\n");
sb.append(" iqn: ").append(toIndentedString(iqn)).append("\n");
sb.append(" iscsiInterface: ").append(toIndentedString(iscsiInterface)).append("\n");
sb.append(" lun: ").append(toIndentedString(lun)).append("\n");
sb.append(" portals: ").append(toIndentedString(portals)).append("\n");
sb.append(" readOnly: ").append(toIndentedString(readOnly)).append("\n");
sb.append(" secretRef: ").append(toIndentedString(secretRef)).append("\n");
sb.append(" targetPortal: ").append(toIndentedString(targetPortal)).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("chapAuthDiscovery");
openapiFields.add("chapAuthSession");
openapiFields.add("fsType");
openapiFields.add("initiatorName");
openapiFields.add("iqn");
openapiFields.add("iscsiInterface");
openapiFields.add("lun");
openapiFields.add("portals");
openapiFields.add("readOnly");
openapiFields.add("secretRef");
openapiFields.add("targetPortal");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("iqn");
openapiRequiredFields.add("lun");
openapiRequiredFields.add("targetPortal");
}
/**
* 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 V1ISCSIVolumeSource
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!V1ISCSIVolumeSource.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in V1ISCSIVolumeSource is not found in the empty JSON string", V1ISCSIVolumeSource.openapiRequiredFields.toString()));
}
}
Set> entries = jsonElement.getAsJsonObject().entrySet();
// check to see if the JSON string contains additional fields
for (Map.Entry entry : entries) {
if (!V1ISCSIVolumeSource.openapiFields.contains(entry.getKey())) {
throw new IllegalArgumentException(String.format("The field `%s` in the JSON string is not defined in the `V1ISCSIVolumeSource` properties. JSON: %s", entry.getKey(), jsonElement.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : V1ISCSIVolumeSource.openapiRequiredFields) {
if (jsonElement.getAsJsonObject().get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonElement.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("fsType") != null && !jsonObj.get("fsType").isJsonNull()) && !jsonObj.get("fsType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `fsType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("fsType").toString()));
}
if ((jsonObj.get("initiatorName") != null && !jsonObj.get("initiatorName").isJsonNull()) && !jsonObj.get("initiatorName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `initiatorName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("initiatorName").toString()));
}
if (!jsonObj.get("iqn").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `iqn` to be a primitive type in the JSON string but got `%s`", jsonObj.get("iqn").toString()));
}
if ((jsonObj.get("iscsiInterface") != null && !jsonObj.get("iscsiInterface").isJsonNull()) && !jsonObj.get("iscsiInterface").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `iscsiInterface` to be a primitive type in the JSON string but got `%s`", jsonObj.get("iscsiInterface").toString()));
}
// ensure the optional json data is an array if present
if (jsonObj.get("portals") != null && !jsonObj.get("portals").isJsonNull() && !jsonObj.get("portals").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `portals` to be an array in the JSON string but got `%s`", jsonObj.get("portals").toString()));
}
// validate the optional field `secretRef`
if (jsonObj.get("secretRef") != null && !jsonObj.get("secretRef").isJsonNull()) {
V1LocalObjectReference.validateJsonElement(jsonObj.get("secretRef"));
}
if (!jsonObj.get("targetPortal").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `targetPortal` to be a primitive type in the JSON string but got `%s`", jsonObj.get("targetPortal").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!V1ISCSIVolumeSource.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'V1ISCSIVolumeSource' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(V1ISCSIVolumeSource.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, V1ISCSIVolumeSource value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
elementAdapter.write(out, obj);
}
@Override
public V1ISCSIVolumeSource read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
return thisAdapter.fromJsonTree(jsonElement);
}
}.nullSafe();
}
}
/**
* Create an instance of V1ISCSIVolumeSource given an JSON string
*
* @param jsonString JSON string
* @return An instance of V1ISCSIVolumeSource
* @throws IOException if the JSON string is invalid with respect to V1ISCSIVolumeSource
*/
public static V1ISCSIVolumeSource fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, V1ISCSIVolumeSource.class);
}
/**
* Convert an instance of V1ISCSIVolumeSource to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}