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

Class MaterialVersionResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.MaterialVersionResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class MaterialVersionResponse extends Object
MaterialVersionResponse

  • Field Details

  • Constructor Details

    • MaterialVersionResponse

      public MaterialVersionResponse()

  • Method Details

    • getDestructionRequestScopeAsString

      public String getDestructionRequestScopeAsString()
      The wire value of destructionRequestScope: 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 getDestructionRequestScope() 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

    • getRevocationCauseAsString

      public String getRevocationCauseAsString()
      The wire value of revocationCause: 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 getRevocationCause() 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

    • getRotationCauseAsString

      public String getRotationCauseAsString()
      The wire value of rotationCause: 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 getRotationCause() 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

    • getStatusAsString

      public String getStatusAsString()
      The wire value of status: 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 getStatus() 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

    • activatedAt

      public MaterialVersionResponse activatedAt(@Nullable OffsetDateTime activatedAt)

    • getActivatedAt

      @Nullable public OffsetDateTime getActivatedAt()
      Timestamp when the material was activated as PRIMARY.
      Returns:
      activatedAt

    • setActivatedAt

      public void setActivatedAt(@Nullable OffsetDateTime activatedAt)

    • algorithm

      public MaterialVersionResponse algorithm(@Nonnull String algorithm)

    • getAlgorithm

      @Nonnull public String getAlgorithm()
      Algorithm of this material version.
      Returns:
      algorithm

    • setAlgorithm

      public void setAlgorithm(@Nonnull String algorithm)

    • destructionEligibleFrom

      public MaterialVersionResponse destructionEligibleFrom(@Nullable OffsetDateTime destructionEligibleFrom)

    • getDestructionEligibleFrom

      @Nullable public OffsetDateTime getDestructionEligibleFrom()
      While the version waits for destruction: when the platform destroys it, the approval of its destruction request plus the cooling-off period.
      Returns:
      destructionEligibleFrom

    • setDestructionEligibleFrom

      public void setDestructionEligibleFrom(@Nullable OffsetDateTime destructionEligibleFrom)

    • destructionRequestScope

      public MaterialVersionResponse destructionRequestScope(@Nullable MaterialVersionResponse.DestructionRequestScopeEnum destructionRequestScope)

    • getDestructionRequestScope

      @Nullable public MaterialVersionResponse.DestructionRequestScopeEnum getDestructionRequestScope()
      What a destruction request for this version requests: MATERIAL destroys this version alone; KEY, when the key has no other version outside a destruction, destroys the whole key and retires its Key ID, and needs admin.keys.mark-for-destruction and an ARCHIVED key. Present only on a RETIRED, REVOKED or PENDING_PRIMARY version of a lineage read.
      Returns:
      destructionRequestScope

    • setDestructionRequestScope

      public void setDestructionRequestScope(@Nullable MaterialVersionResponse.DestructionRequestScopeEnum destructionRequestScope)

    • expiresAt

      public MaterialVersionResponse expiresAt(@Nullable OffsetDateTime expiresAt)

    • getExpiresAt

      @Nullable public OffsetDateTime getExpiresAt()
      Hard expiration timestamp; the material denies new operations past this point.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable OffsetDateTime expiresAt)

    • keyType

      public MaterialVersionResponse keyType(@Nonnull String keyType)

    • getKeyType

      @Nonnull public String getKeyType()
      SIMPLE or COMPOSITE.
      Returns:
      keyType

    • setKeyType

      public void setKeyType(@Nonnull String keyType)

    • retiredAt

      public MaterialVersionResponse retiredAt(@Nullable OffsetDateTime retiredAt)

    • getRetiredAt

      @Nullable public OffsetDateTime getRetiredAt()
      Timestamp when the material entered RETIRED.
      Returns:
      retiredAt

    • setRetiredAt

      public void setRetiredAt(@Nullable OffsetDateTime retiredAt)

    • revocationCause

      public MaterialVersionResponse revocationCause(@Nullable KeyLifecycleCause revocationCause)

    • getRevocationCause

      @Nullable public KeyLifecycleCause getRevocationCause()
      Typed revocation cause when this material has been revoked.
      Returns:
      revocationCause

    • setRevocationCause

      public void setRevocationCause(@Nullable KeyLifecycleCause revocationCause)

    • revocationReason

      public MaterialVersionResponse revocationReason(@Nullable String revocationReason)

    • getRevocationReason

      @Nullable public String getRevocationReason()
      Operator narrative attached to the per-material revocation.
      Returns:
      revocationReason

    • setRevocationReason

      public void setRevocationReason(@Nullable String revocationReason)

    • rotationCause

      public MaterialVersionResponse rotationCause(@Nullable RotationCause rotationCause)

    • getRotationCause

      @Nullable public RotationCause getRotationCause()
      Why this version was created by a rotation: MANUAL when an operator or integration requested the rotation, TIME_BASED when the platform rotated the key because its rotation interval elapsed. Absent when no cause is recorded for the version: the key's first version, which no rotation created, or a version created before the platform recorded rotation causes. Set once, when the version is created, and never changed by a later transition of the version.
      Returns:
      rotationCause

    • setRotationCause

      public void setRotationCause(@Nullable RotationCause rotationCause)

    • status

      public MaterialVersionResponse status(@Nonnull MaterialVersionResponse.StatusEnum status)

    • getStatus

      @Nonnull public MaterialVersionResponse.StatusEnum getStatus()
      Per-material lifecycle status.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull MaterialVersionResponse.StatusEnum status)

    • usageCount

      public MaterialVersionResponse usageCount(@Nullable Integer usageCount)

    • getUsageCount

      @Nullable public Integer getUsageCount()
      Total number of crypto operations executed against this material.
      Returns:
      usageCount

    • setUsageCount

      public void setUsageCount(@Nullable Integer usageCount)

    • version

      public MaterialVersionResponse version(@Nonnull Integer version)

    • getVersion

      @Nonnull public Integer getVersion()
      Monotonically-increasing material version under the alias.
      Returns:
      version

    • setVersion

      public void setVersion(@Nonnull Integer version)

    • 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 MaterialVersionResponse

    • 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 MaterialVersionResponse

    • fromJson

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

    • toJson

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