io.kubernetes.client.openapi.models.V1beta2DeviceSubRequest Maven / Gradle / Ivy
/*
Copyright 2025 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.V1beta2DeviceSelector;
import io.kubernetes.client.openapi.models.V1beta2DeviceToleration;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices. DeviceSubRequest is similar to ExactDeviceRequest, but doesn't expose the AdminAccess field as that one is only supported when requesting a specific device.
*/
@ApiModel(description = "DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices. DeviceSubRequest is similar to ExactDeviceRequest, but doesn't expose the AdminAccess field as that one is only supported when requesting a specific device.")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-05-22T21:20:49.874193Z[Etc/UTC]")
public class V1beta2DeviceSubRequest {
public static final String SERIALIZED_NAME_ALLOCATION_MODE = "allocationMode";
@SerializedName(SERIALIZED_NAME_ALLOCATION_MODE)
private String allocationMode;
public static final String SERIALIZED_NAME_COUNT = "count";
@SerializedName(SERIALIZED_NAME_COUNT)
private Long count;
public static final String SERIALIZED_NAME_DEVICE_CLASS_NAME = "deviceClassName";
@SerializedName(SERIALIZED_NAME_DEVICE_CLASS_NAME)
private String deviceClassName;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_SELECTORS = "selectors";
@SerializedName(SERIALIZED_NAME_SELECTORS)
private List selectors = null;
public static final String SERIALIZED_NAME_TOLERATIONS = "tolerations";
@SerializedName(SERIALIZED_NAME_TOLERATIONS)
private List tolerations = null;
public V1beta2DeviceSubRequest allocationMode(String allocationMode) {
this.allocationMode = allocationMode;
return this;
}
/**
* AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. Supported values are: - ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field. - All: This subrequest is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested. If AllocationMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other subrequests must specify this field. More modes may get added in the future. Clients must refuse to handle requests with unknown modes.
* @return allocationMode
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. Supported values are: - ExactCount: This request is for a specific number of devices. This is the default. The exact number is provided in the count field. - All: This subrequest is for all of the matching devices in a pool. Allocation will fail if some devices are already allocated, unless adminAccess is requested. If AllocationMode is not specified, the default mode is ExactCount. If the mode is ExactCount and count is not specified, the default count is one. Any other subrequests must specify this field. More modes may get added in the future. Clients must refuse to handle requests with unknown modes.")
public String getAllocationMode() {
return allocationMode;
}
public void setAllocationMode(String allocationMode) {
this.allocationMode = allocationMode;
}
public V1beta2DeviceSubRequest count(Long count) {
this.count = count;
return this;
}
/**
* Count is used only when the count mode is \"ExactCount\". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
* @return count
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Count is used only when the count mode is \"ExactCount\". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.")
public Long getCount() {
return count;
}
public void setCount(Long count) {
this.count = count;
}
public V1beta2DeviceSubRequest deviceClassName(String deviceClassName) {
this.deviceClassName = deviceClassName;
return this;
}
/**
* DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest. A class is required. Which classes are available depends on the cluster. Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.
* @return deviceClassName
**/
@ApiModelProperty(required = true, value = "DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest. A class is required. Which classes are available depends on the cluster. Administrators may use this to restrict which devices may get requested by only installing classes with selectors for permitted devices. If users are free to request anything without restrictions, then administrators can create an empty DeviceClass for users to reference.")
public String getDeviceClassName() {
return deviceClassName;
}
public void setDeviceClassName(String deviceClassName) {
this.deviceClassName = deviceClassName;
}
public V1beta2DeviceSubRequest name(String name) {
this.name = name;
return this;
}
/**
* Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format <main request>/<subrequest>. Must be a DNS label.
* @return name
**/
@ApiModelProperty(required = true, value = "Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format /. Must be a DNS label.")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public V1beta2DeviceSubRequest selectors(List selectors) {
this.selectors = selectors;
return this;
}
public V1beta2DeviceSubRequest addSelectorsItem(V1beta2DeviceSelector selectorsItem) {
if (this.selectors == null) {
this.selectors = new ArrayList<>();
}
this.selectors.add(selectorsItem);
return this;
}
/**
* Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this subrequest. All selectors must be satisfied for a device to be considered.
* @return selectors
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this subrequest. All selectors must be satisfied for a device to be considered.")
public List getSelectors() {
return selectors;
}
public void setSelectors(List selectors) {
this.selectors = selectors;
}
public V1beta2DeviceSubRequest tolerations(List tolerations) {
this.tolerations = tolerations;
return this;
}
public V1beta2DeviceSubRequest addTolerationsItem(V1beta2DeviceToleration tolerationsItem) {
if (this.tolerations == null) {
this.tolerations = new ArrayList<>();
}
this.tolerations.add(tolerationsItem);
return this;
}
/**
* If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated. The maximum number of tolerations is 16. This is an alpha field and requires enabling the DRADeviceTaints feature gate.
* @return tolerations
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of the allocated devices get tainted with NoExecute after allocation and that effect is not tolerated, then all pods consuming the ResourceClaim get deleted to evict them. The scheduler will not let new pods reserve the claim while it has these tainted devices. Once all pods are evicted, the claim will get deallocated. The maximum number of tolerations is 16. This is an alpha field and requires enabling the DRADeviceTaints feature gate.")
public List getTolerations() {
return tolerations;
}
public void setTolerations(List tolerations) {
this.tolerations = tolerations;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
V1beta2DeviceSubRequest v1beta2DeviceSubRequest = (V1beta2DeviceSubRequest) o;
return Objects.equals(this.allocationMode, v1beta2DeviceSubRequest.allocationMode) &&
Objects.equals(this.count, v1beta2DeviceSubRequest.count) &&
Objects.equals(this.deviceClassName, v1beta2DeviceSubRequest.deviceClassName) &&
Objects.equals(this.name, v1beta2DeviceSubRequest.name) &&
Objects.equals(this.selectors, v1beta2DeviceSubRequest.selectors) &&
Objects.equals(this.tolerations, v1beta2DeviceSubRequest.tolerations);
}
@Override
public int hashCode() {
return Objects.hash(allocationMode, count, deviceClassName, name, selectors, tolerations);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class V1beta2DeviceSubRequest {\n");
sb.append(" allocationMode: ").append(toIndentedString(allocationMode)).append("\n");
sb.append(" count: ").append(toIndentedString(count)).append("\n");
sb.append(" deviceClassName: ").append(toIndentedString(deviceClassName)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" selectors: ").append(toIndentedString(selectors)).append("\n");
sb.append(" tolerations: ").append(toIndentedString(tolerations)).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(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy