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

Class ExchangeContextResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ExchangeContextResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExchangeContextResponse extends Object
A governed business scenario of the tenant, such as card embossing with one bureau. Every Capability Grant belongs to exactly one context: suspending the context denies every grant in it, and closing it revokes its Cryptographic Exchanges and retires its grants. The context names no application, counterparty or direction; those are the endpoints of its Exchanges.

  • Field Details

  • Constructor Details

    • ExchangeContextResponse

      public ExchangeContextResponse()

  • Method Details

    • getSensitivityAsString

      public String getSensitivityAsString()
      The wire value of sensitivity: 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 getSensitivity() 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

    • businessPurpose

      public ExchangeContextResponse businessPurpose(@Nullable String businessPurpose)

    • getBusinessPurpose

      @Nullable public String getBusinessPurpose()
      Get businessPurpose
      Returns:
      businessPurpose

    • setBusinessPurpose

      public void setBusinessPurpose(@Nullable String businessPurpose)

    • createdAt

      public ExchangeContextResponse createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • description

      public ExchangeContextResponse description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Get description
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • displayName

      public ExchangeContextResponse displayName(@Nullable String displayName)

    • getDisplayName

      @Nullable public String getDisplayName()
      Get displayName
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(@Nullable String displayName)

    • id

      public ExchangeContextResponse id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      Get id
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • name

      public ExchangeContextResponse name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Get name
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • ownedByUseCaseId

      public ExchangeContextResponse ownedByUseCaseId(@Nullable UUID ownedByUseCaseId)

    • getOwnedByUseCaseId

      @Nullable public UUID getOwnedByUseCaseId()
      The Internal Crypto Use Case that owns this context, or null for a context the tenant owns. A use case provisions its own context and owns it for good. A context with an owner admits only that use case's grants: creating, moving, activating or cloning an Exchange into it, adding an Exchange grant, and creating any other Capability Grant in it are refused 409 exchange-context-owned-by-use-case, naming this id, and so is closing it; the use case is revoked through its own operation, which closes the context.
      Returns:
      ownedByUseCaseId

    • setOwnedByUseCaseId

      public void setOwnedByUseCaseId(@Nullable UUID ownedByUseCaseId)

    • regulatoryRegime

      public ExchangeContextResponse regulatoryRegime(@Nullable String regulatoryRegime)

    • getRegulatoryRegime

      @Nullable public String getRegulatoryRegime()
      Free-text name of the regulatory regime the scenario operates under; null when none is recorded.
      Returns:
      regulatoryRegime

    • setRegulatoryRegime

      public void setRegulatoryRegime(@Nullable String regulatoryRegime)

    • sensitivity

      public ExchangeContextResponse sensitivity(@Nonnull ExchangeContextResponse.SensitivityEnum sensitivity)

    • getSensitivity

      @Nonnull public ExchangeContextResponse.SensitivityEnum getSensitivity()
      Get sensitivity
      Returns:
      sensitivity

    • setSensitivity

      public void setSensitivity(@Nonnull ExchangeContextResponse.SensitivityEnum sensitivity)

    • status

      public ExchangeContextResponse status(@Nonnull ExchangeContextResponse.StatusEnum status)

    • getStatus

      @Nonnull public ExchangeContextResponse.StatusEnum getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull ExchangeContextResponse.StatusEnum status)

    • tenantId

      public ExchangeContextResponse tenantId(@Nonnull UUID tenantId)

    • getTenantId

      @Nonnull public UUID getTenantId()
      Get tenantId
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull UUID tenantId)

    • updatedAt

      public ExchangeContextResponse updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

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

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

    • fromJson

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

    • toJson

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