io.k8s.api.resource.v1alpha2.NamedResourcesAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bl-k8s130 Show documentation
Programmatic resource management for Kubernetes
There is a newer version: 1.30.4
package io.k8s.api.resource.v1alpha2;

import com.google.gson.annotations.SerializedName;
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;

/**
 * NamedResourcesAttribute is a combination of an attribute name and its value.
 */
public class NamedResourcesAttribute {
  public Boolean bool;

  @SerializedName("int")
  public Long vInt;

  public NamedResourcesIntSlice intSlice;

  public String name;

  public String quantity;

  public String string;

  public NamedResourcesStringSlice stringSlice;

  public String version;

  /**
   * BoolValue is a true/false value.
   */
  public NamedResourcesAttribute bool(Boolean bool) {
    this.bool = bool;
    return this;
  }

  /**
   * IntValue is a 64-bit integer.
   */
  public NamedResourcesAttribute vInt(Long vInt) {
    this.vInt = vInt;
    return this;
  }

  public NamedResourcesAttribute intSlice(NamedResourcesIntSlice intSlice) {
    this.intSlice = intSlice;
    return this;
  }

  /**
   * Name is unique identifier among all resource instances managed by the driver on the node. It must be a DNS subdomain.
   */
  public NamedResourcesAttribute name(String name) {
    this.name = name;
    return this;
  }

  /**
   * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.
   *
   * The serialization format is:
   *
   * ``` <quantity>        ::= <signedNumber><suffix>
   *
   * 	(Note that <suffix> may be empty, from the "" case in <decimalSI>.)
   *
   * <digit>           ::= 0 | 1 | ... | 9 <digits>          ::= <digit> | <digit><digits> <number>          ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign>            ::= "+" | "-" <signedNumber>    ::= <number> | <sign><number> <suffix>          ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI>        ::= Ki | Mi | Gi | Ti | Pi | Ei
   *
   * 	(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
   *
   * <decimalSI>       ::= m | "" | k | M | G | T | P | E
   *
   * 	(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
   *
   * <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> ```
   *
   * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.
   *
   * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.
   *
   * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:
   *
   * - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible.
   *
   * The sign will be omitted unless the number is negative.
   *
   * Examples:
   *
   * - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi"
   *
   * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.
   *
   * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)
   *
   * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.
   */
  public NamedResourcesAttribute quantity(String quantity) {
    this.quantity = quantity;
    return this;
  }

  /**
   * StringValue is a string.
   */
  public NamedResourcesAttribute string(String string) {
    this.string = string;
    return this;
  }

  public NamedResourcesAttribute stringSlice(NamedResourcesStringSlice stringSlice) {
    this.stringSlice = stringSlice;
    return this;
  }

  /**
   * VersionValue is a semantic version according to semver.org spec 2.0.0.
   */
  public NamedResourcesAttribute version(String version) {
    this.version = version;
    return this;
  }

  public static NamedResourcesAttribute namedResourcesAttribute() {
    return new NamedResourcesAttribute();
  }
}