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

Class CreateExchangeContextRequest

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.CreateExchangeContextRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateExchangeContextRequest extends Object
A governed business scenario of the tenant. It names no application, counterparty or direction: those belong to the Cryptographic Exchanges created in it.

  • Field Details

  • Constructor Details

    • CreateExchangeContextRequest

      public CreateExchangeContextRequest()

  • 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

    • businessPurpose

      public CreateExchangeContextRequest businessPurpose(@Nullable String businessPurpose)

    • getBusinessPurpose

      @Nullable public String getBusinessPurpose()
      Business purpose of the scenario (visible to auditors)
      Returns:
      businessPurpose

    • setBusinessPurpose

      public void setBusinessPurpose(@Nullable String businessPurpose)

    • description

      public CreateExchangeContextRequest description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Free-text description of the scenario
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • displayName

      public CreateExchangeContextRequest displayName(@Nullable String displayName)

    • getDisplayName

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

    • setDisplayName

      public void setDisplayName(@Nullable String displayName)

    • name

      public CreateExchangeContextRequest name(@Nonnull String name)

    • getName

      @Nonnull public String getName()
      Technical slug unique among the live Exchange Contexts of the tenant. Lowercase alphanumerics and hyphens only.
      Returns:
      name

    • setName

      public void setName(@Nonnull String name)

    • regulatoryRegime

      public CreateExchangeContextRequest regulatoryRegime(@Nullable String regulatoryRegime)

    • getRegulatoryRegime

      @Nullable public String getRegulatoryRegime()
      Optional free-text name of the regulatory regime the scenario operates under, at most 120 characters.
      Returns:
      regulatoryRegime

    • setRegulatoryRegime

      public void setRegulatoryRegime(@Nullable String regulatoryRegime)

    • sensitivity

      public CreateExchangeContextRequest sensitivity(@Nullable CreateExchangeContextRequest.SensitivityEnum sensitivity)

    • getSensitivity

      @Nullable public CreateExchangeContextRequest.SensitivityEnum getSensitivity()
      Data classification of the payloads exchanged in the scenario. INTERNAL when omitted.
      Returns:
      sensitivity

    • setSensitivity

      public void setSensitivity(@Nullable CreateExchangeContextRequest.SensitivityEnum sensitivity)

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

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

    • fromJson

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

    • toJson

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