Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.spec

Record Class McpSchema.PaginatedRequest

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.PaginatedRequest
Record Components:
cursor - An opaque token representing the current pagination position. If provided, the server should return results starting after this cursor
meta - See specification for notes on _meta usage
All Implemented Interfaces:
McpSchema.Request
Enclosing class:
McpSchema
public static record McpSchema.PaginatedRequest(String cursor, Map<String,Object> meta) extends Record implements McpSchema.Request
A request that supports pagination using cursors.

  • Constructor Details

    • PaginatedRequest

      public PaginatedRequest(String cursor)

    • PaginatedRequest

      public PaginatedRequest()
      Creates a new paginated request with an empty cursor.

    • PaginatedRequest

      public PaginatedRequest(String cursor, Map<String,Object> meta)
      Creates an instance of a PaginatedRequest record class.
      Parameters:
      cursor - the value for the cursor record component
      meta - the value for the meta record component

  • Method Details

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

    • cursor

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

    • meta

      public Map<String,Object> meta()
      Returns the value of the meta record component.
      Specified by:
      meta in interface McpSchema.Request
      Returns:
      the value of the meta record component