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

Class OperationPermissionPlan

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.OperationPermissionPlan
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class OperationPermissionPlan extends Object
What a conferral would add to the actor. required and confersNew always answer; alreadyHeld and toAdd name scopes and are null unless the caller holds admin.tenant.actor.roles.read — namesVisible says which of the two shapes this is, so a withheld list is never confused with an empty one. No member states how MANY scopes would be added: without roles.read the caller learns only whether anything would be.

  • Field Details

  • Constructor Details

    • OperationPermissionPlan

      public OperationPermissionPlan()

  • Method Details

    • alreadyHeld

      public OperationPermissionPlan alreadyHeld(@Nullable List<String> alreadyHeld)

    • addAlreadyHeldItem

      public OperationPermissionPlan addAlreadyHeldItem(String alreadyHeldItem)

    • getAlreadyHeld

      @Nullable public List<String> getAlreadyHeld()
      The required scopes the actor already holds, sorted. null when the caller does not hold admin.tenant.actor.roles.read.
      Returns:
      alreadyHeld

    • setAlreadyHeld

      public void setAlreadyHeld(@Nullable List<String> alreadyHeld)

    • confersNew

      public OperationPermissionPlan confersNew(@Nullable Boolean confersNew)

    • getConfersNew

      @Nullable public Boolean getConfersNew()
      true when the conferral would add at least one operation scope the actor does not already hold; false when it would add none. Always answers, including when the names are withheld. Without admin.tenant.actor.roles.read it is the only thing the caller learns about the actor's holdings, and the write itself reveals it anyway by being admitted or refused.
      Returns:
      confersNew

    • setConfersNew

      public void setConfersNew(@Nullable Boolean confersNew)

    • namesVisible

      public OperationPermissionPlan namesVisible(@Nullable Boolean namesVisible)

    • getNamesVisible

      @Nullable public Boolean getNamesVisible()
      true when alreadyHeld and toAdd carry names; false when they are withheld and are null.
      Returns:
      namesVisible

    • setNamesVisible

      public void setNamesVisible(@Nullable Boolean namesVisible)

    • required

      public OperationPermissionPlan required(@Nullable List<String> required)

    • addRequiredItem

      public OperationPermissionPlan addRequiredItem(String requiredItem)

    • getRequired

      @Nullable public List<String> getRequired()
      Every operation scope the chosen capability set requires, sorted. Always present.
      Returns:
      required

    • setRequired

      public void setRequired(@Nullable List<String> required)

    • toAdd

      public OperationPermissionPlan toAdd(@Nullable List<String> toAdd)

    • addToAddItem

      public OperationPermissionPlan addToAddItem(String toAddItem)

    • getToAdd

      @Nullable public List<String> getToAdd()
      The required scopes this conferral would add, sorted. null when the caller does not hold admin.tenant.actor.roles.read.
      Returns:
      toAdd

    • setToAdd

      public void setToAdd(@Nullable List<String> toAdd)

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

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

    • fromJson

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

    • toJson

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