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

Class InternalCryptoUseCaseResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.InternalCryptoUseCaseResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class InternalCryptoUseCaseResponse extends Object
InternalCryptoUseCase aggregate projection. On create (201), credential.clientSecret carries the plaintext shown ONCE; on read (200), credential.clientSecret is absent from the JSON payload.

  • Field Details

  • Constructor Details

    • InternalCryptoUseCaseResponse

      public InternalCryptoUseCaseResponse()

  • Method Details

    • 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

    • getTerminalCauseAsString

      public String getTerminalCauseAsString()
      The wire value of terminalCause: 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 getTerminalCause() 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

    • actor

      public InternalCryptoUseCaseResponse actor(@Nullable ActorBlock actor)

    • getActor

      @Nullable public ActorBlock getActor()
      Embedded Actor summary
      Returns:
      actor

    • setActor

      public void setActor(@Nullable ActorBlock actor)

    • applicationId

      public InternalCryptoUseCaseResponse applicationId(@Nullable UUID applicationId)

    • getApplicationId

      @Nullable public UUID getApplicationId()
      Owning application
      Returns:
      applicationId

    • setApplicationId

      public void setApplicationId(@Nullable UUID applicationId)

    • assets

      public InternalCryptoUseCaseResponse assets(@Nullable List<AssetBlock> assets)

    • addAssetsItem

      public InternalCryptoUseCaseResponse addAssetsItem(AssetBlock assetsItem)

    • getAssets

      @Nullable public List<AssetBlock> getAssets()
      Asset references, each carrying the referenced key's own lifecycle status and the role it plays here (0 for interop, 1 for atomic, 2 for cross-kid)
      Returns:
      assets

    • setAssets

      public void setAssets(@Nullable List<AssetBlock> assets)

    • constraintPolicy

      public InternalCryptoUseCaseResponse constraintPolicy(@Nullable ConstraintPolicyBlock constraintPolicy)

    • getConstraintPolicy

      @Nullable public ConstraintPolicyBlock getConstraintPolicy()
      Embedded Constraint Policy summary
      Returns:
      constraintPolicy

    • setConstraintPolicy

      public void setConstraintPolicy(@Nullable ConstraintPolicyBlock constraintPolicy)

    • createdAt

      public InternalCryptoUseCaseResponse createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Creation timestamp
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • credential

      public InternalCryptoUseCaseResponse credential(@Nullable CredentialBlock credential)

    • getCredential

      @Nullable public CredentialBlock getCredential()
      Embedded Credential (plaintext ONLY on 201; null on GET)
      Returns:
      credential

    • setCredential

      public void setCredential(@Nullable CredentialBlock credential)

    • description

      public InternalCryptoUseCaseResponse description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Auditor-readable description
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • displayName

      public InternalCryptoUseCaseResponse displayName(@Nullable String displayName)

    • getDisplayName

      @Nullable public String getDisplayName()
      Human-readable label
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(@Nullable String displayName)

    • exchangeContext

      public InternalCryptoUseCaseResponse exchangeContext(@Nullable ContextBlock exchangeContext)

    • getExchangeContext

      @Nullable public ContextBlock getExchangeContext()
      Embedded Exchange Context summary
      Returns:
      exchangeContext

    • setExchangeContext

      public void setExchangeContext(@Nullable ContextBlock exchangeContext)

    • grants

      public InternalCryptoUseCaseResponse grants(@Nullable List<GrantBlock> grants)

    • addGrantsItem

      public InternalCryptoUseCaseResponse addGrantsItem(GrantBlock grantsItem)

    • getGrants

      @Nullable public List<GrantBlock> getGrants()
      Owned Capability Grants (typically 1..2: ENCRYPT + DECRYPT)
      Returns:
      grants

    • setGrants

      public void setGrants(@Nullable List<GrantBlock> grants)

    • name

      public InternalCryptoUseCaseResponse name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Tenant-scoped slug
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • revokedAt

      public InternalCryptoUseCaseResponse revokedAt(@Nullable OffsetDateTime revokedAt)

    • getRevokedAt

      @Nullable public OffsetDateTime getRevokedAt()
      When the use case was revoked. Absent while it is not REVOKED.
      Returns:
      revokedAt

    • setRevokedAt

      public void setRevokedAt(@Nullable OffsetDateTime revokedAt)

    • revokedReason

      public InternalCryptoUseCaseResponse revokedReason(@Nullable String revokedReason)

    • getRevokedReason

      @Nullable public String getRevokedReason()
      Why the use case was revoked: the operator's text for an operator revocation, or the system's reason token for a cascade (cascade_from_key.destroyed when its key was destroyed). Free text an operator typed; render it as text. Absent while it is not REVOKED.
      Returns:
      revokedReason

    • setRevokedReason

      public void setRevokedReason(@Nullable String revokedReason)

    • status

      public InternalCryptoUseCaseResponse status(@Nullable InternalCryptoUseCaseResponse.StatusEnum status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nullable InternalCryptoUseCaseResponse.StatusEnum status)

    • terminalCause

      public InternalCryptoUseCaseResponse terminalCause(@Nullable InternalCryptoUseCaseResponse.TerminalCauseEnum terminalCause)

    • getTerminalCause

      @Nullable public InternalCryptoUseCaseResponse.TerminalCauseEnum getTerminalCause()
      Why the use case was revoked. KEY_DESTROYED means a key it names was destroyed and the use case ended with it. Absent while it is not REVOKED.
      Returns:
      terminalCause

    • setTerminalCause

      public void setTerminalCause(@Nullable InternalCryptoUseCaseResponse.TerminalCauseEnum terminalCause)

    • terminalCauseKeyIdentity

      public InternalCryptoUseCaseResponse terminalCauseKeyIdentity(@Nullable UUID terminalCauseKeyIdentity)

    • getTerminalCauseKeyIdentity

      @Nullable public UUID getTerminalCauseKeyIdentity()
      Identity (key_aliases.id) of the destroyed key whose destruction revoked the use case. Present exactly when terminalCause is KEY_DESTROYED.
      Returns:
      terminalCauseKeyIdentity

    • setTerminalCauseKeyIdentity

      public void setTerminalCauseKeyIdentity(@Nullable UUID terminalCauseKeyIdentity)

    • useCaseId

      public InternalCryptoUseCaseResponse useCaseId(@Nullable UUID useCaseId)

    • getUseCaseId

      @Nullable public UUID getUseCaseId()
      Aggregate identifier
      Returns:
      useCaseId

    • setUseCaseId

      public void setUseCaseId(@Nullable UUID useCaseId)

    • version

      public InternalCryptoUseCaseResponse version(@Nullable Integer version)

    • getVersion

      @Nullable public Integer getVersion()
      Optimistic-lock discriminator for PATCH/DELETE
      Returns:
      version

    • setVersion

      public void setVersion(@Nullable 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 InternalCryptoUseCaseResponse

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

    • fromJson

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

    • toJson

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