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

Class ScheduleExecutionResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ScheduleExecutionResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ScheduleExecutionResponse extends Object
One execution of a schedule: when it was due, the attempts it took and how it ended.

  • Field Details

  • Constructor Details

    • ScheduleExecutionResponse

      public ScheduleExecutionResponse()

  • Method Details

    • attemptCount

      public ScheduleExecutionResponse attemptCount(@Nonnull Integer attemptCount)

    • getAttemptCount

      @Nonnull public Integer getAttemptCount()
      Delivery attempts made so far.
      Returns:
      attemptCount

    • setAttemptCount

      public void setAttemptCount(@Nonnull Integer attemptCount)

    • completedAt

      public ScheduleExecutionResponse completedAt(@Nullable OffsetDateTime completedAt)

    • getCompletedAt

      @Nullable public OffsetDateTime getCompletedAt()
      When the execution reached a final state (ISO 8601, UTC). Absent while it is in progress.
      Returns:
      completedAt

    • setCompletedAt

      public void setCompletedAt(@Nullable OffsetDateTime completedAt)

    • createdAt

      public ScheduleExecutionResponse createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

      @Nonnull public OffsetDateTime getCreatedAt()
      When the execution was created (ISO 8601, UTC).
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • executionId

      public ScheduleExecutionResponse executionId(@Nonnull UUID executionId)

    • getExecutionId

      @Nonnull public UUID getExecutionId()
      Execution identifier.
      Returns:
      executionId

    • setExecutionId

      public void setExecutionId(@Nonnull UUID executionId)

    • failureClass

      public ScheduleExecutionResponse failureClass(@Nullable String failureClass)

    • getFailureClass

      @Nullable public String getFailureClass()
      Why the last attempt did not end the execution: timeout, io-error, server-error, invalid-domain-result, lease-expired, client-error, lease-insufficient, not-sent or retryable-failure. Absent when no attempt failed.
      Returns:
      failureClass

    • setFailureClass

      public void setFailureClass(@Nullable String failureClass)

    • nextAttemptAt

      public ScheduleExecutionResponse nextAttemptAt(@Nullable OffsetDateTime nextAttemptAt)

    • getNextAttemptAt

      @Nullable public OffsetDateTime getNextAttemptAt()
      When the next attempt is due (ISO 8601, UTC). Present only while the execution waits to retry.
      Returns:
      nextAttemptAt

    • setNextAttemptAt

      public void setNextAttemptAt(@Nullable OffsetDateTime nextAttemptAt)

    • notBefore

      public ScheduleExecutionResponse notBefore(@Nonnull OffsetDateTime notBefore)

    • getNotBefore

      @Nonnull public OffsetDateTime getNotBefore()
      Earliest instant the execution may run (ISO 8601, UTC).
      Returns:
      notBefore

    • setNotBefore

      public void setNotBefore(@Nonnull OffsetDateTime notBefore)

    • ownerRevision

      public ScheduleExecutionResponse ownerRevision(@Nullable Long ownerRevision)

    • getOwnerRevision

      @Nullable public Long getOwnerRevision()
      Revision of the owning domain's intent the execution was planned at. Absent when the owner states none.
      Returns:
      ownerRevision

    • setOwnerRevision

      public void setOwnerRevision(@Nullable Long ownerRevision)

    • readyAt

      public ScheduleExecutionResponse readyAt(@Nullable OffsetDateTime readyAt)

    • getReadyAt

      @Nullable public OffsetDateTime getReadyAt()
      When the execution became ready to run (ISO 8601, UTC). Absent before then.
      Returns:
      readyAt

    • setReadyAt

      public void setReadyAt(@Nullable OffsetDateTime readyAt)

    • reasonCode

      public ScheduleExecutionResponse reasonCode(@Nullable String reasonCode)

    • getReasonCode

      @Nullable public String getReasonCode()
      Why the execution ended as it did, in the owning domain's vocabulary (for a key rotation: rotated, auto-rotation-disabled, superseded-by-newer-revision, ...), or retry-exhausted when retries ran out. Absent while the execution has not ended.
      Returns:
      reasonCode

    • setReasonCode

      public void setReasonCode(@Nullable String reasonCode)

    • result

      public ScheduleExecutionResponse result(@Nullable String result)

    • getResult

      @Nullable public String getResult()
      The target domain's result of a completed execution. Absent while in progress and when nothing was executed.
      Returns:
      result

    • setResult

      public void setResult(@Nullable String result)

    • scheduleId

      public ScheduleExecutionResponse scheduleId(@Nonnull UUID scheduleId)

    • getScheduleId

      @Nonnull public UUID getScheduleId()
      Schedule the execution belongs to.
      Returns:
      scheduleId

    • setScheduleId

      public void setScheduleId(@Nonnull UUID scheduleId)

    • scheduledAt

      public ScheduleExecutionResponse scheduledAt(@Nonnull OffsetDateTime scheduledAt)

    • getScheduledAt

      @Nonnull public OffsetDateTime getScheduledAt()
      When the execution was planned to run (ISO 8601, UTC).
      Returns:
      scheduledAt

    • setScheduledAt

      public void setScheduledAt(@Nonnull OffsetDateTime scheduledAt)

    • state

      public ScheduleExecutionResponse state(@Nonnull String state)

    • getState

      @Nonnull public String getState()
      Execution state. In progress: SCHEDULED, READY, DISPATCHING, RETRY_WAIT. Final: SUCCEEDED, SKIPPED, SUPERSEDED, CANCELLED, TERMINAL_FAILURE, RECONCILIATION_REQUIRED.
      Returns:
      state

    • setState

      public void setState(@Nonnull String state)

    • supersededBy

      public ScheduleExecutionResponse supersededBy(@Nullable UUID supersededBy)

    • getSupersededBy

      @Nullable public UUID getSupersededBy()
      The execution that replaced this one. Present only on a SUPERSEDED execution that has a successor.
      Returns:
      supersededBy

    • setSupersededBy

      public void setSupersededBy(@Nullable UUID supersededBy)

    • toleranceWindow

      public ScheduleExecutionResponse toleranceWindow(@Nullable String toleranceWindow)

    • getToleranceWindow

      @Nullable public String getToleranceWindow()
      How long after notBefore the execution may still run, as an ISO 8601 duration. Absent when no window applies.
      Returns:
      toleranceWindow

    • setToleranceWindow

      public void setToleranceWindow(@Nullable String toleranceWindow)

    • trigger

      public ScheduleExecutionResponse trigger(@Nonnull String trigger)

    • getTrigger

      @Nonnull public String getTrigger()
      What started the execution: TIMER (it fell due) or MANUAL_OPERATOR (an operator ran it).
      Returns:
      trigger

    • setTrigger

      public void setTrigger(@Nonnull String trigger)

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

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

    • fromJson

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

    • toJson

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