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

Class CapabilityOffer

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.CapabilityOffer
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class CapabilityOffer extends Object
One activation capability and whether it may be chosen. When admissible is false, refusal carries the problem document the activation would have returned, so the picker can state the cause rather than only disable the option.

  • Field Details

  • Constructor Details

    • CapabilityOffer

      public CapabilityOffer()

  • 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

    • admissible

      public CapabilityOffer admissible(@Nullable Boolean admissible)

    • getAdmissible

      @Nullable public Boolean getAdmissible()
      Whether activating with this capability would be admitted for the calling operator
      Returns:
      admissible

    • setAdmissible

      public void setAdmissible(@Nullable Boolean admissible)

    • capability

      public CapabilityOffer capability(@Nullable CapabilityOffer.CapabilityEnum capability)

    • getCapability

      @Nullable public CapabilityOffer.CapabilityEnum getCapability()
      The capability
      Returns:
      capability

    • setCapability

      public void setCapability(@Nullable CapabilityOffer.CapabilityEnum capability)

    • refusal

      public CapabilityOffer refusal(@Nullable ProblemDetails refusal)

    • getRefusal

      @Nullable public ProblemDetails getRefusal()
      The problem document the activation would return, or null when admissible. Branch on its type URI, never on its detail text.
      Returns:
      refusal

    • setRefusal

      public void setRefusal(@Nullable ProblemDetails refusal)

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

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

    • fromJson

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

    • toJson

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