Record Class NuggetControl.Request

java.lang.Object
java.lang.Record
org.j7m.middleware.operations.api.NuggetControl.Request
Record Components:
admissionId - accepted Phase 7.1 admission id
securityContext - caller security context for authorization
operationId - caller-supplied replay/idempotency operation id, or empty
correlationId - safe correlation id
action - requested action
mode - requested mode
targetNuggetId - exact target nugget id
targetRuntimeId - exact target runtime id
targetGeneration - expected runtime generation, or 0
confirmation - server-issued confirmation value, or empty
requestedAt - request creation timestamp
deadlineAt - absolute deadline for the complete operation
metadata - safe request metadata
Enclosing class:
NuggetControl
public static record NuggetControl.Request(String admissionId, SecurityContext securityContext, String operationId, String correlationId, NuggetControl.Action action, NuggetControl.Mode mode, String targetNuggetId, String targetRuntimeId, long targetGeneration, String confirmation, Instant requestedAt, Instant deadlineAt, Map<String,String> metadata) extends Record
Nugget-control request metadata.

The admission id and confirmation value are sensitive operational credentials. They are consumed by the server and must not be rendered or audited. The target fields must identify the exact current nugget; an all-target or ambiguous request is invalid at the presentation boundary and must still be rejected by the service if submitted directly.

deadlineAt is the caller's request deadline. A server may also apply a shorter configured control timeout to accepted asynchronous shutdown or termination callbacks. If that server-owned timeout expires, replay with the same operation id reports the retained degraded outcome and does not re-run the callback, even if the original callback later returns.

  • Constructor Details

  • Method Details

    • toString

      public String toString()
      Specified by:
      toString in class Record

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • admissionId

      public String admissionId()
      Returns the value of the admissionId record component.
      Returns:
      the value of the admissionId record component

    • securityContext

      public SecurityContext securityContext()
      Returns the value of the securityContext record component.
      Returns:
      the value of the securityContext record component

    • operationId

      public String operationId()
      Returns the value of the operationId record component.
      Returns:
      the value of the operationId record component

    • correlationId

      public String correlationId()
      Returns the value of the correlationId record component.
      Returns:
      the value of the correlationId record component

    • action

      public NuggetControl.Action action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component

    • mode

      public NuggetControl.Mode mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • targetNuggetId

      public String targetNuggetId()
      Returns the value of the targetNuggetId record component.
      Returns:
      the value of the targetNuggetId record component

    • targetRuntimeId

      public String targetRuntimeId()
      Returns the value of the targetRuntimeId record component.
      Returns:
      the value of the targetRuntimeId record component

    • targetGeneration

      public long targetGeneration()
      Returns the value of the targetGeneration record component.
      Returns:
      the value of the targetGeneration record component

    • confirmation

      public String confirmation()
      Returns the value of the confirmation record component.
      Returns:
      the value of the confirmation record component

    • requestedAt

      public Instant requestedAt()
      Returns the value of the requestedAt record component.
      Returns:
      the value of the requestedAt record component

    • deadlineAt

      public Instant deadlineAt()
      Returns the value of the deadlineAt record component.
      Returns:
      the value of the deadlineAt record component

    • metadata

      public Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component