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

Class OrchestrationKeyRequest

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.OrchestrationKeyRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OrchestrationKeyRequest extends Object
Request for key creation. Permission grants are issued separately.

  • Field Details

  • Constructor Details

    • OrchestrationKeyRequest

      public OrchestrationKeyRequest()

  • Method Details

    • getKdfAsString

      public String getKdfAsString()
      The wire value of kdf: 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 getKdf() 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

    • getPurposeAsString

      public String getPurposeAsString()
      The wire value of purpose: 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 getPurpose() 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

    • algorithm

      public OrchestrationKeyRequest algorithm(@Nonnull String algorithm)

    • getAlgorithm

      @Nonnull public String getAlgorithm()
      Cryptographic algorithm
      Returns:
      algorithm

    • setAlgorithm

      public void setAlgorithm(@Nonnull String algorithm)

    • expiresAt

      public OrchestrationKeyRequest expiresAt(@Nullable String expiresAt)

    • getExpiresAt

      @Nullable public String getExpiresAt()
      Optional expiration timestamp (ISO-8601 Instant). When omitted, the key expires at its creation time plus the maximum cryptoperiod of its key class (NIST SP 800-57 Part 1 Rev. 5, Table 1): 24 months for a symmetric or key-establishment key, 36 months for a signing key. Must be in the future when specified.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable String expiresAt)

    • exportable

      public OrchestrationKeyRequest exportable(@Nullable Boolean exportable)

    • getExportable

      @Nullable public Boolean getExportable()
      Whether the new key's public key may be exported (gates GET /keys/{kid}/export). Optional; when omitted the backend default (false) applies.
      Returns:
      exportable

    • setExportable

      public void setExportable(@Nullable Boolean exportable)

    • kdf

      public OrchestrationKeyRequest kdf(@Nullable OrchestrationKeyRequest.KdfEnum kdf)

    • getKdf

      @Nullable public OrchestrationKeyRequest.KdfEnum getKdf()
      Key derivation function combining the component secrets of a COMPOSITE_KEM_COMBINE key. Optional: when omitted, the cryptographic service applies the pairing's catalogue default. Ignored for simple keys and COMPOSITE_SIGNATURE. Membership is exact in case; an unpublished token is refused before any key material is provisioned.
      Returns:
      kdf

    • setKdf

      public void setKdf(@Nullable OrchestrationKeyRequest.KdfEnum kdf)

    • keyOps

      public OrchestrationKeyRequest keyOps(@Nullable List<String> keyOps)

    • addKeyOpsItem

      public OrchestrationKeyRequest addKeyOpsItem(String keyOpsItem)

    • getKeyOps

      @Nullable public List<String> getKeyOps()
      Allowed key operations
      Returns:
      keyOps

    • setKeyOps

      public void setKeyOps(@Nullable List<String> keyOps)

    • kid

      public OrchestrationKeyRequest kid(@Nonnull String kid)

    • getKid

      @Nonnull public String getKid()
      Human-readable key identifier (kid)
      Returns:
      kid

    • setKid

      public void setKid(@Nonnull String kid)

    • kty

      public OrchestrationKeyRequest kty(@Nonnull String kty)

    • getKty

      @Nonnull public String getKty()
      Key type (kty). Must be a published key type; the set is closed and membership is exact in case. A composite key carries the coarse token COMPOSITE, never a construction name.
      Returns:
      kty

    • setKty

      public void setKty(@Nonnull String kty)

    • maxUsageLimit

      public OrchestrationKeyRequest maxUsageLimit(@Nullable Integer maxUsageLimit)

    • getMaxUsageLimit

      @Nullable public Integer getMaxUsageLimit()
      Hard usage cap; 0 or null = unlimited; must not be negative. Optional; forwarded to the cryptographic service, which owns the default and enforcement. minimum: 0
      Returns:
      maxUsageLimit

    • setMaxUsageLimit

      public void setMaxUsageLimit(@Nullable Integer maxUsageLimit)

    • metadata

      public OrchestrationKeyRequest metadata(@Nullable Map<String,Object> metadata)

    • putMetadataItem

      public OrchestrationKeyRequest putMetadataItem(String key, Object metadataItem)

    • getMetadata

      @Nullable public Map<String,Object> getMetadata()
      Optional metadata
      Returns:
      metadata

    • setMetadata

      public void setMetadata(@Nullable Map<String,Object> metadata)

    • purpose

      public OrchestrationKeyRequest purpose(@Nullable OrchestrationKeyRequest.PurposeEnum purpose)

    • getPurpose

      @Nullable public OrchestrationKeyRequest.PurposeEnum getPurpose()
      Cryptographic purpose. Optional — the cryptographic service derives it from the algorithm's key operations when unambiguous. REQUIRED for ambiguous algorithms whose key operations span both families (RSA, EC): supplying it narrows the operations sent to the cryptographic service to that purpose's family so the cryptographic service can resolve the purpose without returning 422 purpose-required. When omitted for an ambiguous algorithm, the cryptographic service 422 backstop applies.
      Returns:
      purpose

    • setPurpose

      public void setPurpose(@Nullable OrchestrationKeyRequest.PurposeEnum purpose)

    • softLimitExpiration

      public OrchestrationKeyRequest softLimitExpiration(@Nullable String softLimitExpiration)

    • getSoftLimitExpiration

      @Nullable public String getSoftLimitExpiration()
      Optional soft/warning expiry timestamp (ISO-8601 Instant); must be before expiresAt, stated or defaulted (server-enforced, 400 otherwise). When omitted, two months before expiresAt and never before the creation time. Optional; forwarded raw to the cryptographic service, which owns the default and the ordering validation.
      Returns:
      softLimitExpiration

    • setSoftLimitExpiration

      public void setSoftLimitExpiration(@Nullable String softLimitExpiration)

    • softUsageLimit

      public OrchestrationKeyRequest softUsageLimit(@Nullable Integer softUsageLimit)

    • getSoftUsageLimit

      @Nullable public Integer getSoftUsageLimit()
      Soft usage warning threshold; must be less than maxUsageLimit (server-enforced); 0 or null = no soft threshold; must not be negative. Optional; forwarded to the cryptographic service, which owns the soft<max validation. minimum: 0
      Returns:
      softUsageLimit

    • setSoftUsageLimit

      public void setSoftUsageLimit(@Nullable Integer softUsageLimit)

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

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

    • fromJson

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

    • toJson

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