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

Record Class McpSchema.SubscribeRequest

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.SubscribeRequest
Record Components:
uri - the URI of the resource to subscribe to. The URI can use any protocol; it is up to the server how to interpret it.
meta - See specification for notes on _meta usage
All Implemented Interfaces:
McpSchema.Request
Enclosing class:
McpSchema
public static record McpSchema.SubscribeRequest(String uri, Map<String,Object> meta) extends Record implements McpSchema.Request
Sent from the client to request resources/updated notifications from the server whenever a particular resource changes.

  • Constructor Details

    • SubscribeRequest

      public SubscribeRequest(String uri)

    • SubscribeRequest

      public SubscribeRequest(String uri, Map<String,Object> meta)
      Creates an instance of a SubscribeRequest record class.
      Parameters:
      uri - the value for the uri 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.

    • uri

      public String uri()
      Returns the value of the uri record component.
      Returns:
      the value of the uri 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