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

Class GrantEffectiveState

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.GrantEffectiveState
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class GrantEffectiveState extends Object
Whether the governance objects the administration plane owns let the grant authorize at the instant of the read, and why not: the owning Exchange or Internal Crypto Use Case, the Exchange Context, the actor, the grant itself and its pinned Constraint Policy version, with the version's schedule read in the platform schedule time zone. Key lifecycle, rate windows and usage counts are NOT evaluated; the cryptographic service decides them per request, so a usable grant can still be refused at use.

  • Field Details

  • Constructor Details

    • GrantEffectiveState

      public GrantEffectiveState()

  • Method Details

    • getReasonAsString

      public String getReasonAsString()
      The wire value of reason: 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 getReason() 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

    • reason

      public GrantEffectiveState reason(@Nullable GrantEffectiveState.ReasonEnum reason)

    • getReason

      @Nullable public GrantEffectiveState.ReasonEnum getReason()
      The first reason that stops the grant, in the precedence of the vocabulary; null when usable
      Returns:
      reason

    • setReason

      public void setReason(@Nullable GrantEffectiveState.ReasonEnum reason)

    • usable

      public GrantEffectiveState usable(@Nonnull Boolean usable)

    • getUsable

      @Nonnull public Boolean getUsable()
      true when nothing the administration plane owns stops the grant
      Returns:
      usable

    • setUsable

      public void setUsable(@Nonnull Boolean usable)

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

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

    • fromJson

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

    • toJson

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