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

Class ActivateRequest

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ActivateRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ActivateRequest extends Object
Activate a READY Exchange (creates the Capability Grant atomically)

  • Field Details

  • Constructor Details

    • ActivateRequest

      public ActivateRequest()

  • Method Details

    • getCapabilityAsString

      public String getCapabilityAsString()
      The wire value of capability: 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 getCapability() 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

    • capability

      public ActivateRequest capability(@Nonnull ActivateRequest.CapabilityEnum capability)

    • getCapability

      @Nonnull public ActivateRequest.CapabilityEnum getCapability()
      Cryptographic capability for the new Grant. Exactly four values are accepted here — ENCRYPT, DECRYPT, SIGN, VERIFY — and any other value is rejected with 400. The Capability vocabulary also holds the two cross-kid operations REENCRYPT and RESIGN, and they are NOT activatable through this endpoint: an Exchange carries a single assetKid, while a cross-kid grant binds a [source, target] KID pair. Grant those with createCapabilityGrant (POST /api/v3/admin/tenants/{tenantId}/capability-grants) supplying exactly two assetKids.
      Returns:
      capability

    • setCapability

      public void setCapability(@Nonnull ActivateRequest.CapabilityEnum capability)

    • version

      public ActivateRequest version(@Nonnull Integer version)

    • getVersion

      @Nonnull public Integer getVersion()
      Optimistic-lock version of the Exchange
      Returns:
      version

    • setVersion

      public void setVersion(@Nonnull 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 ActivateRequest

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

    • fromJson

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

    • toJson

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