Package co.ankatech.keymanagement.client.keymanagement.model

Class RotationScheduleCeiling

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.RotationScheduleCeiling
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class RotationScheduleCeiling extends Object
Maximum cryptoperiod the compliance packs state for the key's class (NIST SP 800-57 Part 1 Rev. 5 ยง5.3.6), which bounds the key's rotation interval.

  • Field Details

  • Constructor Details

    • RotationScheduleCeiling

      public RotationScheduleCeiling()

  • Method Details

    • getBasisAsString

      public String getBasisAsString()
      The wire value of basis: what the server sent, verbatim.
      • For a value this release declares, the same wire value the enum names.
      • For a value it does not declare (one a later server added), the server's wire value verbatim, while getBasis() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • getKeyClassAsString

      public String getKeyClassAsString()
      The wire value of keyClass: what the server sent, verbatim.
      • For a value this release declares, the same wire value the enum names.
      • For a value it does not declare (one a later server added), the server's wire value verbatim, while getKeyClass() reads UNKNOWN_DEFAULT_OPEN_API; writing this model sends that wire value back, never the sentinel.
      • For an absent member, null.
      Returns:
      the wire value, or null when the member is absent

    • basis

      public RotationScheduleCeiling basis(@Nonnull CryptoperiodCeilingBasis basis)

    • getBasis

      @Nonnull public CryptoperiodCeilingBasis getBasis()
      Which packs the maximum was read from.
      Returns:
      basis

    • setBasis

      public void setBasis(@Nonnull CryptoperiodCeilingBasis basis)

    • keyClass

      public RotationScheduleCeiling keyClass(@Nonnull CryptoperiodKeyClass keyClass)

    • getKeyClass

      @Nonnull public CryptoperiodKeyClass getKeyClass()
      Key class the maximum applies to, decided on the key's type and operations.
      Returns:
      keyClass

    • setKeyClass

      public void setKeyClass(@Nonnull CryptoperiodKeyClass keyClass)

    • maximumMonths

      public RotationScheduleCeiling maximumMonths(@Nullable Integer maximumMonths)

    • getMaximumMonths

      @Nullable public Integer getMaximumMonths()
      Maximum in calendar months from the creation of the key's primary material. Null when no applicable pack states one for the class.
      Returns:
      maximumMonths

    • setMaximumMonths

      public void setMaximumMonths(@Nullable Integer maximumMonths)

    • packIds

      public RotationScheduleCeiling packIds(@Nonnull List<String> packIds)

    • addPackIdsItem

      public RotationScheduleCeiling addPackIdsItem(String packIdsItem)

    • getPackIds

      @Nonnull public List<String> getPackIds()
      Compliance packs that state the maximum; empty when none does.
      Returns:
      packIds

    • setPackIds

      public void setPackIds(@Nonnull List<String> packIds)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to RotationScheduleCeiling

    • validateJsonElementAsCandidate

      public static void validateJsonElementAsCandidate(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element as a candidate of a oneOf schema: the checks of validateJsonElement(JsonElement), and the element carries no member this model does not declare. A oneOf schema without a discriminator tells its candidates apart by their member sets, so a candidate is matched on its closed member set.
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is not a RotationScheduleCeiling

    • fromJson

      public static RotationScheduleCeiling fromJson(String jsonString) throws IOException
      Create an instance of RotationScheduleCeiling given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of RotationScheduleCeiling
      Throws:
      IOException - if the JSON string is invalid with respect to RotationScheduleCeiling

    • toJson

      public String toJson()
      Convert an instance of RotationScheduleCeiling to an JSON string
      Returns:
      JSON string