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

Class ExchangeActivationPreviewResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ExchangeActivationPreviewResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExchangeActivationPreviewResponse extends Object
What activating, resuming or inspecting this Exchange would confer. Writes nothing. mode decides which members are populated; version is the optimistic-lock discriminator the subsequent write must echo.

  • Field Details

  • Constructor Details

    • ExchangeActivationPreviewResponse

      public ExchangeActivationPreviewResponse()

  • Method Details

    • getExchangeStatusAsString

      public String getExchangeStatusAsString()
      The wire value of exchangeStatus: 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 getExchangeStatus() 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

    • getModeAsString

      public String getModeAsString()
      The wire value of mode: 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 getMode() 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

    • capabilities

      public ExchangeActivationPreviewResponse capabilities(@Nullable List<CapabilityOffer> capabilities)

    • addCapabilitiesItem

      public ExchangeActivationPreviewResponse addCapabilitiesItem(CapabilityOffer capabilitiesItem)

    • getCapabilities

      @Nullable public List<CapabilityOffer> getCapabilities()
      One offer per activation capability. Empty unless mode is ACTIVATE.
      Returns:
      capabilities

    • setCapabilities

      public void setCapabilities(@Nullable List<CapabilityOffer> capabilities)

    • exchangeId

      public ExchangeActivationPreviewResponse exchangeId(@Nullable UUID exchangeId)

    • getExchangeId

      @Nullable public UUID getExchangeId()
      The Exchange this preview describes
      Returns:
      exchangeId

    • setExchangeId

      public void setExchangeId(@Nullable UUID exchangeId)

    • exchangeStatus

      public ExchangeActivationPreviewResponse exchangeStatus(@Nullable ExchangeActivationPreviewResponse.ExchangeStatusEnum exchangeStatus)

    • getExchangeStatus

      @Nullable public ExchangeActivationPreviewResponse.ExchangeStatusEnum getExchangeStatus()
      The Exchange's current lifecycle status
      Returns:
      exchangeStatus

    • setExchangeStatus

      public void setExchangeStatus(@Nullable ExchangeActivationPreviewResponse.ExchangeStatusEnum exchangeStatus)

    • mode

      public ExchangeActivationPreviewResponse mode(@Nullable ExchangeActivationPreviewResponse.ModeEnum mode)

    • getMode

      @Nullable public ExchangeActivationPreviewResponse.ModeEnum getMode()
      Which operation this preview is about
      Returns:
      mode

    • setMode

      public void setMode(@Nullable ExchangeActivationPreviewResponse.ModeEnum mode)

    • plan

      public ExchangeActivationPreviewResponse plan(@Nullable ConferralPlanResponse plan)

    • getPlan

      @Nullable public ConferralPlanResponse getPlan()
      The conferral plan for the chosen capability, or null when no capability was named and the mode is ACTIVATE.
      Returns:
      plan

    • setPlan

      public void setPlan(@Nullable ConferralPlanResponse plan)

    • version

      public ExchangeActivationPreviewResponse version(@Nullable Integer version)

    • getVersion

      @Nullable public Integer getVersion()
      Optimistic-lock discriminator to echo on the activate or resume call
      Returns:
      version

    • setVersion

      public void setVersion(@Nullable 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 ExchangeActivationPreviewResponse

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

    • fromJson

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

    • toJson

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