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

Class ScheduleResponse

java.lang.Object
co.ankatech.keymanagement.client.keymanagement.model.ScheduleResponse
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class ScheduleResponse extends Object
One durable schedule of a tenant: the obligation it carries, the resource it acts on and its status. Metadata only; no key material and no secret.

  • Field Details

  • Constructor Details

    • ScheduleResponse

      public ScheduleResponse()

  • Method Details

    • createdAt

      public ScheduleResponse createdAt(@Nonnull OffsetDateTime createdAt)

    • getCreatedAt

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

    • setCreatedAt

      public void setCreatedAt(@Nonnull OffsetDateTime createdAt)

    • definitionKind

      public ScheduleResponse definitionKind(@Nonnull String definitionKind)

    • getDefinitionKind

      @Nonnull public String getDefinitionKind()
      How executions follow one another: ONE_SHOT (a single execution), CHAINED_ONE_SHOT (each execution plans the next one from its result) or RECURRING (a fixed cadence).
      Returns:
      definitionKind

    • setDefinitionKind

      public void setDefinitionKind(@Nonnull String definitionKind)

    • intentType

      public ScheduleResponse intentType(@Nonnull String intentType)

    • getIntentType

      @Nonnull public String getIntentType()
      What each execution asks the target domain to do.
      Returns:
      intentType

    • setIntentType

      public void setIntentType(@Nonnull String intentType)

    • ownerDomain

      public ScheduleResponse ownerDomain(@Nonnull String ownerDomain)

    • getOwnerDomain

      @Nonnull public String getOwnerDomain()
      Domain that owns the obligation. KEY_LIFECYCLE for a key's automatic rotation.
      Returns:
      ownerDomain

    • setOwnerDomain

      public void setOwnerDomain(@Nonnull String ownerDomain)

    • ownerReference

      public ScheduleResponse ownerReference(@Nonnull String ownerReference)

    • getOwnerReference

      @Nonnull public String getOwnerReference()
      The owning domain's reference of the obligation. For a key's automatic rotation, key-rotation: followed by the key's identity, the uuid the key reads answer.
      Returns:
      ownerReference

    • setOwnerReference

      public void setOwnerReference(@Nonnull String ownerReference)

    • resourceId

      public ScheduleResponse resourceId(@Nonnull String resourceId)

    • getResourceId

      @Nonnull public String getResourceId()
      Resource the schedule acts on. For a key, its stable key identifier (kid).
      Returns:
      resourceId

    • setResourceId

      public void setResourceId(@Nonnull String resourceId)

    • resourceType

      public ScheduleResponse resourceType(@Nonnull String resourceType)

    • getResourceType

      @Nonnull public String getResourceType()
      Type of the resource the schedule acts on.
      Returns:
      resourceType

    • setResourceType

      public void setResourceType(@Nonnull String resourceType)

    • scheduleId

      public ScheduleResponse scheduleId(@Nonnull UUID scheduleId)

    • getScheduleId

      @Nonnull public UUID getScheduleId()
      Schedule identifier, used to list its executions.
      Returns:
      scheduleId

    • setScheduleId

      public void setScheduleId(@Nonnull UUID scheduleId)

    • sourceRevision

      public ScheduleResponse sourceRevision(@Nonnull Long sourceRevision)

    • getSourceRevision

      @Nonnull public Long getSourceRevision()
      Revision of the owning domain's intent the schedule reflects. It grows each time the obligation changes (a new rotation interval, a manual rotation, a disabled schedule).
      Returns:
      sourceRevision

    • setSourceRevision

      public void setSourceRevision(@Nonnull Long sourceRevision)

    • status

      public ScheduleResponse status(@Nonnull String status)

    • getStatus

      @Nonnull public String getStatus()
      Schedule status: ACTIVE (executions are planned), PAUSED (planning is held), CANCELLED (the obligation was withdrawn; terminal) or COMPLETED (nothing more is due; terminal).
      Returns:
      status

    • setStatus

      public void setStatus(@Nonnull String status)

    • targetDomain

      public ScheduleResponse targetDomain(@Nonnull String targetDomain)

    • getTargetDomain

      @Nonnull public String getTargetDomain()
      Domain each execution is delivered to.
      Returns:
      targetDomain

    • setTargetDomain

      public void setTargetDomain(@Nonnull String targetDomain)

    • tenantId

      public ScheduleResponse tenantId(@Nonnull UUID tenantId)

    • getTenantId

      @Nonnull public UUID getTenantId()
      Tenant that owns the schedule; always the tenant in the request path.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull UUID tenantId)

    • updatedAt

      public ScheduleResponse updatedAt(@Nonnull OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nonnull public OffsetDateTime getUpdatedAt()
      When the schedule last changed (ISO 8601, UTC).
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nonnull 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 ScheduleResponse

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

    • fromJson

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

    • toJson

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