Record Class OperationParameterSchema.FieldSpec

java.lang.Object
java.lang.Record
zeroecho.pki.server.schema.OperationParameterSchema.FieldSpec
Record Components:
name - argument name
type - JSON wire type
required - whether omission is rejected
choices - permitted enum constants, empty for other types
Enclosing class:
OperationParameterSchema
public static record OperationParameterSchema.FieldSpec(String name, OperationParameterSchema.FieldType type, boolean required, List<String> choices) extends Record
Specification for one operation argument field.

  • Constructor Details

  • Method Details

    • text

      public static OperationParameterSchema.FieldSpec text(String name, boolean required)
      Defines a string argument.
      Parameters:
      name - argument name
      required - whether omission is rejected
      Returns:
      immutable string field

    • integer

      public static OperationParameterSchema.FieldSpec integer(String name, boolean required)
      Defines an integer argument; decoder-specific bounds still apply.
      Parameters:
      name - argument name
      required - whether omission is rejected
      Returns:
      immutable integer field

    • bool

      public static OperationParameterSchema.FieldSpec bool(String name, boolean required)
      Defines a boolean argument.
      Parameters:
      name - argument name
      required - whether omission is rejected
      Returns:
      immutable boolean field

    • textSet

      public static OperationParameterSchema.FieldSpec textSet(String name, boolean required)
      Defines a set of strings encoded as a JSON array.
      Parameters:
      name - argument name
      required - whether omission is rejected
      Returns:
      immutable string-set field

    • base64

      public static OperationParameterSchema.FieldSpec base64(String name, boolean required)
      Defines standard Base64 binary data encoded as a JSON string.
      Parameters:
      name - argument name
      required - whether omission is rejected
      Returns:
      immutable binary field

    • object

      public static OperationParameterSchema.FieldSpec object(String name, boolean required)
      Defines a nested JSON argument.
      Parameters:
      name - argument name
      required - whether omission is rejected
      Returns:
      immutable field definition

    • enum_

      public static OperationParameterSchema.FieldSpec enum_(String name, boolean required, List<String> choices)
      Defines one enum constant encoded as a JSON string.
      Parameters:
      name - argument name
      required - whether omission is rejected
      choices - permitted constants
      Returns:
      immutable enum field

    • enumSet

      public static OperationParameterSchema.FieldSpec enumSet(String name, boolean required, List<String> choices)
      Defines enum constants encoded as a JSON array.
      Parameters:
      name - argument name
      required - whether omission is rejected
      choices - permitted constants
      Returns:
      immutable enum-set field

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • type

      public OperationParameterSchema.FieldType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • choices

      public List<String> choices()
      Returns the value of the choices record component.
      Returns:
      the value of the choices record component