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

Class ExchangeListItemResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ExchangeListItemResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ExchangeListItemResponse extends Object
List-page projection of a Cryptographic Exchange

  • Field Details

  • Constructor Details

    • ExchangeListItemResponse

      public ExchangeListItemResponse()

  • Method Details

    • getRelationshipAsString

      public String getRelationshipAsString()
      The wire value of relationship: 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 getRelationship() 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

    • getStatusAsString

      public String getStatusAsString()
      The wire value of status: 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 getStatus() 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

    • getTerminalCauseAsString

      public String getTerminalCauseAsString()
      The wire value of terminalCause: 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 getTerminalCause() 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

    • destination

      public ExchangeListItemResponse destination(@Nullable ExchangeEndpoint destination)

    • getDestination

      @Nullable public ExchangeEndpoint getDestination()
      Where the relationship ends
      Returns:
      destination

    • setDestination

      public void setDestination(@Nullable ExchangeEndpoint destination)

    • effectiveFrom

      public ExchangeListItemResponse effectiveFrom(@Nullable OffsetDateTime effectiveFrom)

    • getEffectiveFrom

      @Nullable public OffsetDateTime getEffectiveFrom()
      Validity window start
      Returns:
      effectiveFrom

    • setEffectiveFrom

      public void setEffectiveFrom(@Nullable OffsetDateTime effectiveFrom)

    • effectiveUntil

      public ExchangeListItemResponse effectiveUntil(@Nullable OffsetDateTime effectiveUntil)

    • getEffectiveUntil

      @Nullable public OffsetDateTime getEffectiveUntil()
      Validity window end
      Returns:
      effectiveUntil

    • setEffectiveUntil

      public void setEffectiveUntil(@Nullable OffsetDateTime effectiveUntil)

    • exchangeContextId

      public ExchangeListItemResponse exchangeContextId(@Nullable UUID exchangeContextId)

    • getExchangeContextId

      @Nullable public UUID getExchangeContextId()
      Exchange Context reference id
      Returns:
      exchangeContextId

    • setExchangeContextId

      public void setExchangeContextId(@Nullable UUID exchangeContextId)

    • exchangeContextName

      public ExchangeListItemResponse exchangeContextName(@Nullable String exchangeContextName)

    • getExchangeContextName

      @Nullable public String getExchangeContextName()
      Exchange Context display name
      Returns:
      exchangeContextName

    • setExchangeContextName

      public void setExchangeContextName(@Nullable String exchangeContextName)

    • grants

      public ExchangeListItemResponse grants(@Nullable List<ExchangeGrantSummary> grants)

    • addGrantsItem

      public ExchangeListItemResponse addGrantsItem(ExchangeGrantSummary grantsItem)

    • getGrants

      @Nullable public List<ExchangeGrantSummary> getGrants()
      The Capability Grants the Exchange owns, live and retired, oldest first
      Returns:
      grants

    • setGrants

      public void setGrants(@Nullable List<ExchangeGrantSummary> grants)

    • id

      public ExchangeListItemResponse id(@Nullable UUID id)

    • getId

      @Nullable public UUID getId()
      Stable Exchange UUID
      Returns:
      id

    • setId

      public void setId(@Nullable UUID id)

    • name

      public ExchangeListItemResponse name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Display name
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • origin

      public ExchangeListItemResponse origin(@Nullable ExchangeEndpoint origin)

    • getOrigin

      @Nullable public ExchangeEndpoint getOrigin()
      Where the relationship starts
      Returns:
      origin

    • setOrigin

      public void setOrigin(@Nullable ExchangeEndpoint origin)

    • ownerPrincipalId

      public ExchangeListItemResponse ownerPrincipalId(@Nullable UUID ownerPrincipalId)

    • getOwnerPrincipalId

      @Nullable public UUID getOwnerPrincipalId()
      Owner principal UUID
      Returns:
      ownerPrincipalId

    • setOwnerPrincipalId

      public void setOwnerPrincipalId(@Nullable UUID ownerPrincipalId)

    • relationship

      public ExchangeListItemResponse relationship(@Nullable ExchangeListItemResponse.RelationshipEnum relationship)

    • getRelationship

      @Nullable public ExchangeListItemResponse.RelationshipEnum getRelationship()
      SELF, INTERNAL, OUTBOUND or INBOUND, derived from the endpoints
      Returns:
      relationship

    • setRelationship

      public void setRelationship(@Nullable ExchangeListItemResponse.RelationshipEnum relationship)

    • scheduleTimeZone

      public ExchangeListItemResponse scheduleTimeZone(@Nonnull String scheduleTimeZone)

    • getScheduleTimeZone

      @Nonnull public String getScheduleTimeZone()
      The time zone in which the schedules of the grants' Constraint Policy versions are evaluated: the platform setting authorization.schedule.timezone, an IANA region zone or UTC.
      Returns:
      scheduleTimeZone

    • setScheduleTimeZone

      public void setScheduleTimeZone(@Nonnull String scheduleTimeZone)

    • status

      public ExchangeListItemResponse status(@Nullable ExchangeListItemResponse.StatusEnum status)

    • getStatus

      @Nullable public ExchangeListItemResponse.StatusEnum getStatus()
      Lifecycle status
      Returns:
      status

    • setStatus

      public void setStatus(@Nullable ExchangeListItemResponse.StatusEnum status)

    • suspendedAt

      public ExchangeListItemResponse suspendedAt(@Nullable OffsetDateTime suspendedAt)

    • getSuspendedAt

      @Nullable public OffsetDateTime getSuspendedAt()
      When the Exchange was suspended; present only while it is SUSPENDED
      Returns:
      suspendedAt

    • setSuspendedAt

      public void setSuspendedAt(@Nullable OffsetDateTime suspendedAt)

    • suspendedBy

      public ExchangeListItemResponse suspendedBy(@Nullable String suspendedBy)

    • getSuspendedBy

      @Nullable public String getSuspendedBy()
      Who suspended the Exchange; present only while it is SUSPENDED. Shown to a caller seated in the platform tenant; any other caller (an impersonation session and core-api relaying a tenant caller's read included) receives it only when it names a member of the caller's own tenant, and otherwise receives it withheld (absent or null): a platform operator's principal, a service or system principal, and a value that names neither a live member nor one of the tenant's own Cryptographic Actors.
      Returns:
      suspendedBy

    • setSuspendedBy

      public void setSuspendedBy(@Nullable String suspendedBy)

    • suspendedReason

      public ExchangeListItemResponse suspendedReason(@Nullable String suspendedReason)

    • getSuspendedReason

      @Nullable public String getSuspendedReason()
      Why the Exchange was suspended; present only while it is SUSPENDED
      Returns:
      suspendedReason

    • setSuspendedReason

      public void setSuspendedReason(@Nullable String suspendedReason)

    • terminalCause

      public ExchangeListItemResponse terminalCause(@Nullable ExchangeListItemResponse.TerminalCauseEnum terminalCause)

    • getTerminalCause

      @Nullable public ExchangeListItemResponse.TerminalCauseEnum getTerminalCause()
      Why the Exchange reached its terminal state. KEY_DESTROYED means the key it names was destroyed and the Exchange ended with it; CONSUMED means its last live Capability Grant was used up (single use taken, or maxUsage reached). Absent while the Exchange is not REVOKED, EXPIRED or CONSUMED.
      Returns:
      terminalCause

    • setTerminalCause

      public void setTerminalCause(@Nullable ExchangeListItemResponse.TerminalCauseEnum terminalCause)

    • terminalCauseKeyIdentity

      public ExchangeListItemResponse terminalCauseKeyIdentity(@Nullable UUID terminalCauseKeyIdentity)

    • getTerminalCauseKeyIdentity

      @Nullable public UUID getTerminalCauseKeyIdentity()
      Identity (key_aliases.id) of the destroyed key whose destruction ended the Exchange. Present exactly when terminalCause is KEY_DESTROYED.
      Returns:
      terminalCauseKeyIdentity

    • setTerminalCauseKeyIdentity

      public void setTerminalCauseKeyIdentity(@Nullable UUID terminalCauseKeyIdentity)

    • updatedAt

      public ExchangeListItemResponse updatedAt(@Nullable OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Last modification timestamp (default sort)
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable OffsetDateTime updatedAt)

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

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

    • fromJson

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

    • toJson

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