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

Class ExchangeDetailResponse

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

  • Field Details

  • Constructor Details

    • ExchangeDetailResponse

      public ExchangeDetailResponse()

  • 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

    • actorId

      public ExchangeDetailResponse actorId(@Nullable UUID actorId)

    • getActorId

      @Nullable public UUID getActorId()
      Actor reference id
      Returns:
      actorId

    • setActorId

      public void setActorId(@Nullable UUID actorId)

    • actorName

      public ExchangeDetailResponse actorName(@Nullable String actorName)

    • getActorName

      @Nullable public String getActorName()
      Actor display name
      Returns:
      actorName

    • setActorName

      public void setActorName(@Nullable String actorName)

    • applicationId

      public ExchangeDetailResponse applicationId(@Nullable UUID applicationId)

    • getApplicationId

      @Nullable public UUID getApplicationId()
      Application reference id
      Returns:
      applicationId

    • setApplicationId

      public void setApplicationId(@Nullable UUID applicationId)

    • applicationName

      public ExchangeDetailResponse applicationName(@Nullable String applicationName)

    • getApplicationName

      @Nullable public String getApplicationName()
      Application display name
      Returns:
      applicationName

    • setApplicationName

      public void setApplicationName(@Nullable String applicationName)

    • assetKid

      public ExchangeDetailResponse assetKid(@Nullable String assetKid)

    • getAssetKid

      @Nullable public String getAssetKid()
      Asset KID (string identifier)
      Returns:
      assetKid

    • setAssetKid

      public void setAssetKid(@Nullable String assetKid)

    • businessPurpose

      public ExchangeDetailResponse businessPurpose(@Nullable String businessPurpose)

    • getBusinessPurpose

      @Nullable public String getBusinessPurpose()
      Business purpose
      Returns:
      businessPurpose

    • setBusinessPurpose

      public void setBusinessPurpose(@Nullable String businessPurpose)

    • clonedFromExchangeId

      public ExchangeDetailResponse clonedFromExchangeId(@Nullable UUID clonedFromExchangeId)

    • getClonedFromExchangeId

      @Nullable public UUID getClonedFromExchangeId()
      Source Exchange id when produced via clone (provenance)
      Returns:
      clonedFromExchangeId

    • setClonedFromExchangeId

      public void setClonedFromExchangeId(@Nullable UUID clonedFromExchangeId)

    • constraintPolicyId

      public ExchangeDetailResponse constraintPolicyId(@Nullable UUID constraintPolicyId)

    • getConstraintPolicyId

      @Nullable public UUID getConstraintPolicyId()
      Constraint Policy reference id
      Returns:
      constraintPolicyId

    • setConstraintPolicyId

      public void setConstraintPolicyId(@Nullable UUID constraintPolicyId)

    • constraintPolicyName

      public ExchangeDetailResponse constraintPolicyName(@Nullable String constraintPolicyName)

    • getConstraintPolicyName

      @Nullable public String getConstraintPolicyName()
      Constraint Policy display name
      Returns:
      constraintPolicyName

    • setConstraintPolicyName

      public void setConstraintPolicyName(@Nullable String constraintPolicyName)

    • counterparty

      public ExchangeDetailResponse counterparty(@Nullable String counterparty)

    • getCounterparty

      @Nullable public String getCounterparty()
      Counterparty name
      Returns:
      counterparty

    • setCounterparty

      public void setCounterparty(@Nullable String counterparty)

    • createdAt

      public ExchangeDetailResponse createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Audit: created at
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • createdBy

      public ExchangeDetailResponse createdBy(@Nullable String createdBy)

    • getCreatedBy

      @Nullable public String getCreatedBy()
      Audit: created by. Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      createdBy

    • setCreatedBy

      public void setCreatedBy(@Nullable String createdBy)

    • effectiveFrom

      public ExchangeDetailResponse effectiveFrom(@Nullable OffsetDateTime effectiveFrom)

    • getEffectiveFrom

      @Nullable public OffsetDateTime getEffectiveFrom()
      Validity window start
      Returns:
      effectiveFrom

    • setEffectiveFrom

      public void setEffectiveFrom(@Nullable OffsetDateTime effectiveFrom)

    • effectiveUntil

      public ExchangeDetailResponse effectiveUntil(@Nullable OffsetDateTime effectiveUntil)

    • getEffectiveUntil

      @Nullable public OffsetDateTime getEffectiveUntil()
      Validity window end
      Returns:
      effectiveUntil

    • setEffectiveUntil

      public void setEffectiveUntil(@Nullable OffsetDateTime effectiveUntil)

    • exchangeContextId

      public ExchangeDetailResponse exchangeContextId(@Nullable UUID exchangeContextId)

    • getExchangeContextId

      @Nullable public UUID getExchangeContextId()
      Exchange Context reference id
      Returns:
      exchangeContextId

    • setExchangeContextId

      public void setExchangeContextId(@Nullable UUID exchangeContextId)

    • exchangeContextName

      public ExchangeDetailResponse exchangeContextName(@Nullable String exchangeContextName)

    • getExchangeContextName

      @Nullable public String getExchangeContextName()
      Exchange Context display name
      Returns:
      exchangeContextName

    • setExchangeContextName

      public void setExchangeContextName(@Nullable String exchangeContextName)

    • grantId

      public ExchangeDetailResponse grantId(@Nullable UUID grantId)

    • getGrantId

      @Nullable public UUID getGrantId()
      Owned Capability Grant reference id (NULL while DRAFT/READY)
      Returns:
      grantId

    • setGrantId

      public void setGrantId(@Nullable UUID grantId)

    • id

      public ExchangeDetailResponse id(@Nullable UUID id)

    • getId

      @Nullable public UUID getId()
      Stable Exchange UUID
      Returns:
      id

    • setId

      public void setId(@Nullable UUID id)

    • name

      public ExchangeDetailResponse name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Display name
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • notes

      public ExchangeDetailResponse notes(@Nullable String notes)

    • getNotes

      @Nullable public String getNotes()
      Free-text notes
      Returns:
      notes

    • setNotes

      public void setNotes(@Nullable String notes)

    • operationPermissions

      public ExchangeDetailResponse operationPermissions(@Nullable ExchangeOperationPermissions operationPermissions)

    • getOperationPermissions

      @Nullable public ExchangeOperationPermissions getOperationPermissions()
      Whether the Exchange's actor holds the operation scopes its capability grant needs. Null while the Exchange owns no grant. Its missing member is null when the caller does not hold admin.tenant.actor.roles.read.
      Returns:
      operationPermissions

    • setOperationPermissions

      public void setOperationPermissions(@Nullable ExchangeOperationPermissions operationPermissions)

    • ownerPrincipalId

      public ExchangeDetailResponse ownerPrincipalId(@Nullable UUID ownerPrincipalId)

    • getOwnerPrincipalId

      @Nullable public UUID getOwnerPrincipalId()
      Owner principal UUID
      Returns:
      ownerPrincipalId

    • setOwnerPrincipalId

      public void setOwnerPrincipalId(@Nullable UUID ownerPrincipalId)

    • revokedAt

      public ExchangeDetailResponse revokedAt(@Nullable OffsetDateTime revokedAt)

    • getRevokedAt

      @Nullable public OffsetDateTime getRevokedAt()
      Revocation timestamp (REVOKED/EXPIRED/CONSUMED only)
      Returns:
      revokedAt

    • setRevokedAt

      public void setRevokedAt(@Nullable OffsetDateTime revokedAt)

    • revokedBy

      public ExchangeDetailResponse revokedBy(@Nullable String revokedBy)

    • getRevokedBy

      @Nullable public String getRevokedBy()
      Revocation actor (REVOKED/EXPIRED/CONSUMED only). Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      revokedBy

    • setRevokedBy

      public void setRevokedBy(@Nullable String revokedBy)

    • revokedReason

      public ExchangeDetailResponse revokedReason(@Nullable String revokedReason)

    • getRevokedReason

      @Nullable public String getRevokedReason()
      Revocation reason (REVOKED/EXPIRED/CONSUMED only)
      Returns:
      revokedReason

    • setRevokedReason

      public void setRevokedReason(@Nullable String revokedReason)

    • status

      public ExchangeDetailResponse status(@Nullable ExchangeDetailResponse.StatusEnum status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nullable ExchangeDetailResponse.StatusEnum status)

    • tags

      public ExchangeDetailResponse tags(@Nullable List<String> tags)

    • addTagsItem

      public ExchangeDetailResponse addTagsItem(String tagsItem)

    • getTags

      @Nullable public List<String> getTags()
      Free-form tags
      Returns:
      tags

    • setTags

      public void setTags(@Nullable List<String> tags)

    • tenantId

      public ExchangeDetailResponse tenantId(@Nullable UUID tenantId)

    • getTenantId

      @Nullable public UUID getTenantId()
      Tenant UUID (denormalized; matches the JWT tenantId of the requester)
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nullable UUID tenantId)

    • terminalCause

      public ExchangeDetailResponse terminalCause(@Nullable ExchangeDetailResponse.TerminalCauseEnum terminalCause)

    • getTerminalCause

      @Nullable public ExchangeDetailResponse.TerminalCauseEnum getTerminalCause()
      Why the Exchange reached its terminal state. KEY_DESTROYED means the key it names was destroyed and the Exchange ended with it; CONSUMED means its Capability Grant was used up (single use taken, or maxUsage reached). Absent while the Exchange is not REVOKED, EXPIRED or CONSUMED.
      Returns:
      terminalCause

    • setTerminalCause

      public void setTerminalCause(@Nullable ExchangeDetailResponse.TerminalCauseEnum terminalCause)

    • terminalCauseKeyIdentity

      public ExchangeDetailResponse terminalCauseKeyIdentity(@Nullable UUID terminalCauseKeyIdentity)

    • getTerminalCauseKeyIdentity

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

    • setTerminalCauseKeyIdentity

      public void setTerminalCauseKeyIdentity(@Nullable UUID terminalCauseKeyIdentity)

    • updatedAt

      public ExchangeDetailResponse updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Audit: last updated at
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

    • updatedBy

      public ExchangeDetailResponse updatedBy(@Nullable String updatedBy)

    • getUpdatedBy

      @Nullable public String getUpdatedBy()
      Audit: last updated by. Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      updatedBy

    • setUpdatedBy

      public void setUpdatedBy(@Nullable String updatedBy)

    • version

      public ExchangeDetailResponse version(@Nullable Integer version)

    • getVersion

      @Nullable public Integer getVersion()
      Optimistic-lock version of the Exchange (carry into PATCH and state-transition request bodies)
      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 ExchangeDetailResponse

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

    • fromJson

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

    • toJson

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