Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.ElicitRequest

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ElicitRequest

Record Components:

message - The message to present to the user

requestedSchema - A restricted subset of JSON Schema. Only top-level properties are allowed, without nesting

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Request

Enclosing class:

McpSchema

public static record McpSchema.ElicitRequest(String message, Map<String,Object> requestedSchema, Map<String,Object> meta)
extends Record
implements McpSchema.Request

A request from the server to elicit additional information from the user via the client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.ElicitRequest.Builder

Constructor Summary

Constructors

Constructor	Description
ElicitRequest(String message, Map<String,Object> requestedSchema)
ElicitRequest(String message, Map<String,Object> requestedSchema, Map<String,Object> meta)	Creates an instance of a ElicitRequest record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.ElicitRequest.Builder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
Map<String,Object>	meta()	Returns the value of the meta record component.
Map<String,Object>	requestedSchema()	Returns the value of the requestedSchema record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.modelcontextprotocol.spec.McpSchema.Request

progressToken

Constructor Details

ElicitRequest

public ElicitRequest(String message,
 Map<String,Object> requestedSchema)

ElicitRequest

public ElicitRequest(String message,
 Map<String,Object> requestedSchema,
 Map<String,Object> meta)

Creates an instance of a ElicitRequest record class.

Parameters:

message - the value for the message record component

requestedSchema - the value for the requestedSchema record component

meta - the value for the meta record component

Method Details

builder

public static McpSchema.ElicitRequest.Builder builder()

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.

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

requestedSchema

public Map<String,Object> requestedSchema()

Returns the value of the requestedSchema record component.

Returns:

the value of the requestedSchema 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