Class CreateCapabilityGrantRequest

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.CreateCapabilityGrantRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CreateCapabilityGrantRequest extends Object
CreateCapabilityGrantRequest
  • Field Details

  • Constructor Details

    • CreateCapabilityGrantRequest

      public CreateCapabilityGrantRequest()
  • Method Details

    • actorId

      public CreateCapabilityGrantRequest actorId(@Nonnull UUID actorId)
    • getActorId

      @Nonnull public UUID getActorId()
      Cryptographic Actor that the grant authorises
      Returns:
      actorId
    • setActorId

      public void setActorId(@Nonnull UUID actorId)
    • allowWildcardAsset

      public CreateCapabilityGrantRequest allowWildcardAsset(@Nullable Boolean allowWildcardAsset)
    • getAllowWildcardAsset

      @Nullable public Boolean getAllowWildcardAsset()
      Opt-in flag required for a wildcard basic grant (empty assetKids). Admitted only in a STANDARD tenant. Optional: omitting it is equivalent to false.
      Returns:
      allowWildcardAsset
    • setAllowWildcardAsset

      public void setAllowWildcardAsset(@Nullable Boolean allowWildcardAsset)
    • assetKids

      public CreateCapabilityGrantRequest assetKids(@Nullable List<String> assetKids)
    • addAssetKidsItem

      public CreateCapabilityGrantRequest addAssetKidsItem(String assetKidsItem)
    • getAssetKids

      @Nullable public List<String> getAssetKids()
      The Key ID a basic grant authorizes: exactly one. Empty or absent with allowWildcardAsset=true is the any-asset wildcard. Absent or empty for a REENCRYPT or RESIGN grant, whose keys are its keyPairs.
      Returns:
      assetKids
    • setAssetKids

      public void setAssetKids(@Nullable List<String> assetKids)
    • capabilities

      public CreateCapabilityGrantRequest capabilities(@Nonnull List<String> capabilities)
    • addCapabilitiesItem

      public CreateCapabilityGrantRequest addCapabilitiesItem(String capabilitiesItem)
    • getCapabilities

      @Nonnull public List<String> getCapabilities()
      Capabilities of the grant: one to four of ENCRYPT, DECRYPT, SIGN, VERIFY, or exactly one of REENCRYPT, RESIGN alone. REENCRYPT never implies DECRYPT.
      Returns:
      capabilities
    • setCapabilities

      public void setCapabilities(@Nonnull List<String> capabilities)
    • constraintPolicyId

      public CreateCapabilityGrantRequest constraintPolicyId(@Nullable UUID constraintPolicyId)
    • getConstraintPolicyId

      @Nullable public UUID getConstraintPolicyId()
      Optional Constraint Policy to attach; the grant enforces its current version
      Returns:
      constraintPolicyId
    • setConstraintPolicyId

      public void setConstraintPolicyId(@Nullable UUID constraintPolicyId)
    • exchangeContextId

      public CreateCapabilityGrantRequest exchangeContextId(@Nonnull UUID exchangeContextId)
    • getExchangeContextId

      @Nonnull public UUID getExchangeContextId()
      The Exchange Context the grant authorizes in. It must be an ACTIVE context of the tenant; a token naming another context is denied by the grant.
      Returns:
      exchangeContextId
    • setExchangeContextId

      public void setExchangeContextId(@Nonnull UUID exchangeContextId)
    • keyPairs

      public CreateCapabilityGrantRequest keyPairs(@Nullable List<CapabilityGrantKeyPair> keyPairs)
    • addKeyPairsItem

      public CreateCapabilityGrantRequest addKeyPairsItem(CapabilityGrantKeyPair keyPairsItem)
    • getKeyPairs

      @Nullable public List<CapabilityGrantKeyPair> getKeyPairs()
      The ordered key pairs a REENCRYPT or RESIGN grant authorizes, one or more (at most 32); each authorizes the transformation from its sourceKid to its targetKid only. Absent or empty for a basic grant.
      Returns:
      keyPairs
    • setKeyPairs

      public void setKeyPairs(@Nullable List<CapabilityGrantKeyPair> keyPairs)
    • 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 CreateCapabilityGrantRequest
    • 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 CreateCapabilityGrantRequest
    • fromJson

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

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