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

Class KeyExportResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.KeyExportResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class KeyExportResponse extends Object
Complete key metadata and PUBLIC key material. Private key material is never returned. Mirrors the cryptographic service's key export response.

  • Field Details

  • Constructor Details

    • KeyExportResponse

      public KeyExportResponse()

  • Method Details

    • getCompositeModeAsString

      public String getCompositeModeAsString()
      The wire value of compositeMode: 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 getCompositeMode() 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

    • getOriginAsString

      public String getOriginAsString()
      The wire value of origin: 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 getOrigin() 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

    • getTypeAsString

      public String getTypeAsString()
      The wire value of type: 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 getType() 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

    • alg

      public KeyExportResponse alg(@Nullable String alg)

    • getAlg

      @Nullable public String getAlg()
      Algorithm identifier.
      Returns:
      alg

    • setAlg

      public void setAlg(@Nullable String alg)

    • components

      public KeyExportResponse components(@Nullable List<KeyComponentResponse> components)

    • addComponentsItem

      public KeyExportResponse addComponentsItem(KeyComponentResponse componentsItem)

    • getComponents

      @Nullable public List<KeyComponentResponse> getComponents()
      Component PUBLIC keys for COMPOSITE keys. Null for SIMPLE keys.
      Returns:
      components

    • setComponents

      public void setComponents(@Nullable List<KeyComponentResponse> components)

    • compositeMode

      public KeyExportResponse compositeMode(@Nullable KeyExportResponse.CompositeModeEnum compositeMode)

    • getCompositeMode

      @Nullable public KeyExportResponse.CompositeModeEnum getCompositeMode()
      How a composite key's components are combined — the construction axis that a coarse key type deliberately does not carry. Absent for simple keys.
      Returns:
      compositeMode

    • setCompositeMode

      public void setCompositeMode(@Nullable KeyExportResponse.CompositeModeEnum compositeMode)

    • createdAt

      public KeyExportResponse createdAt(@Nullable String createdAt)

    • getCreatedAt

      @Nullable public String getCreatedAt()
      ISO-8601 UTC creation timestamp.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable String createdAt)

    • expiresAt

      public KeyExportResponse expiresAt(@Nullable String expiresAt)

    • getExpiresAt

      @Nullable public String getExpiresAt()
      ISO-8601 UTC hard expiration timestamp.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nullable String expiresAt)

    • exportable

      public KeyExportResponse exportable(@Nullable Boolean exportable)

    • getExportable

      @Nullable public Boolean getExportable()
      Whether the public key material can be exported.
      Returns:
      exportable

    • setExportable

      public void setExportable(@Nullable Boolean exportable)

    • kdf

      public KeyExportResponse kdf(@Nullable String kdf)

    • getKdf

      @Nullable public String getKdf()
      Key Derivation Function for COMPOSITE_KEM_COMBINE keys.
      Returns:
      kdf

    • setKdf

      public void setKdf(@Nullable String kdf)

    • keyOps

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

    • addKeyOpsItem

      public KeyExportResponse addKeyOpsItem(String keyOpsItem)

    • getKeyOps

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

    • setKeyOps

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

    • kid

      public KeyExportResponse kid(@Nullable String kid)

    • getKid

      @Nullable public String getKid()
      Unique key identifier (kid).
      Returns:
      kid

    • setKid

      public void setKid(@Nullable String kid)

    • kty

      public KeyExportResponse kty(@Nullable String kty)

    • getKty

      @Nullable public String getKty()
      Key type (kty). Simple keys carry their own family; every composite key carries the single coarse token COMPOSITE and reports its construction in compositeMode.
      Returns:
      kty

    • setKty

      public void setKty(@Nullable String kty)

    • lastUsedAt

      public KeyExportResponse lastUsedAt(@Nullable String lastUsedAt)

    • getLastUsedAt

      @Nullable public String getLastUsedAt()
      ISO-8601 UTC timestamp of the last operation.
      Returns:
      lastUsedAt

    • setLastUsedAt

      public void setLastUsedAt(@Nullable String lastUsedAt)

    • maxUsageLimit

      public KeyExportResponse maxUsageLimit(@Nullable Integer maxUsageLimit)

    • getMaxUsageLimit

      @Nullable public Integer getMaxUsageLimit()
      Maximum operations permitted. 0/null means unlimited.
      Returns:
      maxUsageLimit

    • setMaxUsageLimit

      public void setMaxUsageLimit(@Nullable Integer maxUsageLimit)

    • origin

      public KeyExportResponse origin(@Nullable KeyExportResponse.OriginEnum origin)

    • getOrigin

      @Nullable public KeyExportResponse.OriginEnum getOrigin()
      How the key was created: GENERATED or IMPORTED.
      Returns:
      origin

    • setOrigin

      public void setOrigin(@Nullable KeyExportResponse.OriginEnum origin)

    • publicKey

      public KeyExportResponse publicKey(@Nullable String publicKey)

    • getPublicKey

      @Nullable public String getPublicKey()
      Base64-encoded PUBLIC key material. Null for symmetric and composite keys.
      Returns:
      publicKey

    • setPublicKey

      public void setPublicKey(@Nullable String publicKey)

    • restricted

      public KeyExportResponse restricted(@Nullable Boolean restricted)

    • getRestricted

      @Nullable public Boolean getRestricted()
      Whether the key has operational restrictions.
      Returns:
      restricted

    • setRestricted

      public void setRestricted(@Nullable Boolean restricted)

    • softLimitExpiration

      public KeyExportResponse softLimitExpiration(@Nullable String softLimitExpiration)

    • getSoftLimitExpiration

      @Nullable public String getSoftLimitExpiration()
      ISO-8601 UTC soft-limit expiration timestamp.
      Returns:
      softLimitExpiration

    • setSoftLimitExpiration

      public void setSoftLimitExpiration(@Nullable String softLimitExpiration)

    • softUsageLimit

      public KeyExportResponse softUsageLimit(@Nullable Integer softUsageLimit)

    • getSoftUsageLimit

      @Nullable public Integer getSoftUsageLimit()
      Soft-limit usage count for warnings.
      Returns:
      softUsageLimit

    • setSoftUsageLimit

      public void setSoftUsageLimit(@Nullable Integer softUsageLimit)

    • status

      public KeyExportResponse status(@Nullable String status)

    • getStatus

      @Nullable public String getStatus()
      Lifecycle state.
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable String status)

    • type

      public KeyExportResponse type(@Nullable KeyExportResponse.TypeEnum type)

    • getType

      @Nullable public KeyExportResponse.TypeEnum getType()
      Key structure: SIMPLE or COMPOSITE.
      Returns:
      type

    • setType

      public void setType(@Nullable KeyExportResponse.TypeEnum type)

    • usageCount

      public KeyExportResponse usageCount(@Nullable Integer usageCount)

    • getUsageCount

      @Nullable public Integer getUsageCount()
      Number of operations performed with this key.
      Returns:
      usageCount

    • setUsageCount

      public void setUsageCount(@Nullable Integer usageCount)

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

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

    • fromJson

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

    • toJson

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