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

Class QuorumRequestResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.QuorumRequestResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class QuorumRequestResponse extends Object
A gated operation waiting for, or decided by, its quorum of approvers.

  • Field Details

  • Constructor Details

    • QuorumRequestResponse

      public QuorumRequestResponse()

  • Method Details

    • getOperationAsString

      public String getOperationAsString()
      The wire value of operation: 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 getOperation() 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

    • getPlaneAsString

      public String getPlaneAsString()
      The wire value of plane: 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 getPlane() 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

    • getRequesterTypeAsString

      public String getRequesterTypeAsString()
      The wire value of requesterType: 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 getRequesterType() 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

    • approvals

      public QuorumRequestResponse approvals(@Nonnull Integer approvals)

    • getApprovals

      @Nonnull public Integer getApprovals()
      The approvals recorded so far.
      Returns:
      approvals

    • setApprovals

      public void setApprovals(@Nonnull Integer approvals)

    • decisions

      public QuorumRequestResponse decisions(@Nonnull List<QuorumDecision> decisions)

    • addDecisionsItem

      public QuorumRequestResponse addDecisionsItem(QuorumDecision decisionsItem)

    • getDecisions

      @Nonnull public List<QuorumDecision> getDecisions()
      Every decision, oldest first.
      Returns:
      decisions

    • setDecisions

      public void setDecisions(@Nonnull List<QuorumDecision> decisions)

    • destruction

      public QuorumRequestResponse destruction(@Nullable QuorumDestructionRequest destruction)

    • getDestruction

      @Nullable public QuorumDestructionRequest getDestruction()
      What a key or material destruction request asks to destroy, as it was made. Present only on KEY_MARK_FOR_DESTRUCTION and KEY_MATERIAL_MARK_FOR_DESTRUCTION requests.
      Returns:
      destruction

    • setDestruction

      public void setDestruction(@Nullable QuorumDestructionRequest destruction)

    • expiresAt

      public QuorumRequestResponse expiresAt(@Nonnull OffsetDateTime expiresAt)

    • getExpiresAt

      @Nonnull public OffsetDateTime getExpiresAt()
      Until when it may be approved. It bounds the approval only: once a request is SCHEDULED its quorum was reached, takesEffectAt governs, and expiresAt may be earlier than takesEffectAt without the request expiring.
      Returns:
      expiresAt

    • setExpiresAt

      public void setExpiresAt(@Nonnull OffsetDateTime expiresAt)

    • failureDetail

      public QuorumRequestResponse failureDetail(@Nullable String failureDetail)

    • getFailureDetail

      @Nullable public String getFailureDetail()
      The detail of that refusal.
      Returns:
      failureDetail

    • setFailureDetail

      public void setFailureDetail(@Nullable String failureDetail)

    • failureType

      public QuorumRequestResponse failureType(@Nullable String failureType)

    • getFailureType

      @Nullable public String getFailureType()
      The RFC 9457 problem type of the refusal that ended a FAILED request.
      Returns:
      failureType

    • setFailureType

      public void setFailureType(@Nullable String failureType)

    • impersonated

      public QuorumRequestResponse impersonated(@Nonnull Boolean impersonated)

    • getImpersonated

      @Nonnull public Boolean getImpersonated()
      True when a platform operator made the request under a support-access impersonation of requestedBy: the member did not ask in person. The operator is not named.
      Returns:
      impersonated

    • setImpersonated

      public void setImpersonated(@Nonnull Boolean impersonated)

    • operation

      public QuorumRequestResponse operation(@Nonnull QuorumRequestResponse.OperationEnum operation)

    • getOperation

      @Nonnull public QuorumRequestResponse.OperationEnum getOperation()
      The gated operation.
      Returns:
      operation

    • setOperation

      public void setOperation(@Nonnull QuorumRequestResponse.OperationEnum operation)

    • plane

      public QuorumRequestResponse plane(@Nonnull QuorumRequestResponse.PlaneEnum plane)

    • getPlane

      @Nonnull public QuorumRequestResponse.PlaneEnum getPlane()
      TENANT for a tenant's request; DEPLOYMENT for a platform request.
      Returns:
      plane

    • setPlane

      public void setPlane(@Nonnull QuorumRequestResponse.PlaneEnum plane)

    • requestId

      public QuorumRequestResponse requestId(@Nonnull UUID requestId)

    • getRequestId

      @Nonnull public UUID getRequestId()
      The request id.
      Returns:
      requestId

    • setRequestId

      public void setRequestId(@Nonnull UUID requestId)

    • requestedAt

      public QuorumRequestResponse requestedAt(@Nonnull OffsetDateTime requestedAt)

    • getRequestedAt

      @Nonnull public OffsetDateTime getRequestedAt()
      When it was created.
      Returns:
      requestedAt

    • setRequestedAt

      public void setRequestedAt(@Nonnull OffsetDateTime requestedAt)

    • requestedBy

      public QuorumRequestResponse requestedBy(@Nonnull String requestedBy)

    • getRequestedBy

      @Nonnull public String getRequestedBy()
      Who asked for the operation.
      Returns:
      requestedBy

    • setRequestedBy

      public void setRequestedBy(@Nonnull String requestedBy)

    • requesterType

      public QuorumRequestResponse requesterType(@Nonnull QuorumRequestResponse.RequesterTypeEnum requesterType)

    • getRequesterType

      @Nonnull public QuorumRequestResponse.RequesterTypeEnum getRequesterType()
      IDENTITY when a person requested; WORKLOAD when an administrative workload identity did; APPLICATION when an application did, with its own token or an actor's. A workload or an application may request; only a person approves, and never one accountable for the requesting application.
      Returns:
      requesterType

    • setRequesterType

      public void setRequesterType(@Nonnull QuorumRequestResponse.RequesterTypeEnum requesterType)

    • requiredApprovals

      public QuorumRequestResponse requiredApprovals(@Nonnull Integer requiredApprovals)

    • getRequiredApprovals

      @Nonnull public Integer getRequiredApprovals()
      The approvals it needs, set when it was created. A later raise of the policy's required approvals applies to it; a lowering does not.
      Returns:
      requiredApprovals

    • setRequiredApprovals

      public void setRequiredApprovals(@Nonnull Integer requiredApprovals)

    • resolvedAt

      public QuorumRequestResponse resolvedAt(@Nullable OffsetDateTime resolvedAt)

    • getResolvedAt

      @Nullable public OffsetDateTime getResolvedAt()
      When it ended. Absent while PENDING, SCHEDULED or EXPIRED.
      Returns:
      resolvedAt

    • setResolvedAt

      public void setResolvedAt(@Nullable OffsetDateTime resolvedAt)

    • status

      public QuorumRequestResponse status(@Nonnull QuorumRequestResponse.StatusEnum status)

    • getStatus

      @Nonnull public QuorumRequestResponse.StatusEnum getStatus()
      PENDING while it waits; EXECUTED once its quorum was reached and the operation ran; SCHEDULED when its quorum was reached and it takes effect at takesEffectAt (a platform recovery, which the tenant may cancel until then); FAILED when the operation refused to run at that moment (failureType says why); REJECTED by an approver; CANCELLED by its requester, by the tenant, or because its requester can no longer act; EXPIRED when it waited past expiresAt.
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull QuorumRequestResponse.StatusEnum status)

    • takesEffectAt

      public QuorumRequestResponse takesEffectAt(@Nullable OffsetDateTime takesEffectAt)

    • getTakesEffectAt

      @Nullable public OffsetDateTime getTakesEffectAt()
      When a SCHEDULED request takes effect. Absent for every other status but a request that was SCHEDULED and then ended.
      Returns:
      takesEffectAt

    • setTakesEffectAt

      public void setTakesEffectAt(@Nullable OffsetDateTime takesEffectAt)

    • target

      public QuorumRequestResponse target(@Nonnull String target)

    • getTarget

      @Nonnull public String getTarget()
      What the operation acts on.
      Returns:
      target

    • setTarget

      public void setTarget(@Nonnull String target)

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

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

    • fromJson

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

    • toJson

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