Module org.elasticsearch.server
Package org.elasticsearch.action.admin.cluster.snapshots.get

Record Class After

java.lang.Object
java.lang.Record
org.elasticsearch.action.admin.cluster.snapshots.get.After
All Implemented Interfaces:
Writeable
public record After(String value, String repoName, String snapshotName) extends Record implements Writeable
Cursor value for the ?after pagination parameter of the get-snapshots API. Encodes the sort key value plus snapshot and repository names for tiebreaking. Can be decoded from a query param and passed in a GetSnapshotsRequest, and used by AfterPredicates to filter out snapshots that are not after this cursor.

  • Constructor Details

    • After

      public After(StreamInput in) throws IOException
      Throws:
      IOException

    • After

      public After(String value, String repoName, String snapshotName)
      Creates an instance of a After record class.
      Parameters:
      value - the value for the value record component
      repoName - the value for the repoName record component
      snapshotName - the value for the snapshotName record component

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • fromSnapshotInfo

      public static After fromSnapshotInfo(SnapshotInfo snapshotInfo, SnapshotSortKey sortBy)
      Build an After cursor from the last snapshot in a page, for use when building the ?after value for the next request.
      Parameters:
      snapshotInfo - the snapshot (typically the last in the current page)
      sortBy - the sort key used for the request
      Returns:
      the cursor

    • toQueryParam

      public String toQueryParam()
      Encode this cursor as the ?after query parameter value (base64url-encoded "value,repoName,snapshotName").
      Returns:
      the encoded string for use as the after query parameter

    • decodeAfterQueryParam

      public static After decodeAfterQueryParam(String param)
      Decode the ?after query parameter into an After instance.
      Parameters:
      param - the value of the after query parameter (base64url-encoded "value,repoName,snapshotName")
      Returns:
      the decoded cursor
      Throws:
      IllegalArgumentException - if the parameter format is invalid

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

    • value

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

    • repoName

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

    • snapshotName

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