Package io.jenkins.plugins.batchcontrol.store

Record Class RequestSummary

java.lang.Object
java.lang.Record
io.jenkins.plugins.batchcontrol.store.RequestSummary
Record Components:
id - request id (sortable by creation time)
jobFullName - target job
requester - requesting user id
status - current status
createdAt - creation instant
decidedAt - decision instant, or null while undecided
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public record RequestSummary(String id, String jobFullName, String requester, RequestStatus status, Instant createdAt, Instant decidedAt) extends Record
The few fields of a run request that listings filter and sort on, kept in memory by the store so a listing reads only the XML files of the rows it renders. Derived data: rebuilt from requests/run/*.xml once per Jenkins session and updated on every save.

  • Constructor Details

    • RequestSummary

      public RequestSummary(String id, String jobFullName, String requester, RequestStatus status, Instant createdAt, @CheckForNull Instant decidedAt)
      Creates an instance of a RequestSummary record class.
      Parameters:
      id - the value for the id record component
      jobFullName - the value for the jobFullName record component
      requester - the value for the requester record component
      status - the value for the status record component
      createdAt - the value for the createdAt record component
      decidedAt - the value for the decidedAt record component

  • Method Details

    • isOpen

      public boolean isOpen()
      PENDING or APPROVED: the only statuses the expiry, recovery and invalidation work acts on.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • id

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

    • jobFullName

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

    • requester

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

    • status

      public RequestStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • createdAt

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

    • decidedAt

      @CheckForNull public Instant decidedAt()
      Returns the value of the decidedAt record component.
      Returns:
      the value of the decidedAt record component