Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.ElicitResult

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ElicitResult

Record Components:

action - The user action in response to the elicitation. "accept": User submitted the form/confirmed the action, "decline": User explicitly declined the action, "cancel": User dismissed without making an explicit choice

content - The submitted form data, only present when action is "accept". Contains values matching the requested schema

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Result

Enclosing class:

McpSchema

public static record McpSchema.ElicitResult(McpSchema.ElicitResult.Action action, Map<String,Object> content, Map<String,Object> meta)
extends Record
implements McpSchema.Result

The client's response to an elicitation request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	McpSchema.ElicitResult.Action
static class	McpSchema.ElicitResult.Builder

Constructor Summary

Constructors

Constructor	Description
ElicitResult(McpSchema.ElicitResult.Action action, Map<String,Object> content)
ElicitResult(McpSchema.ElicitResult.Action action, Map<String,Object> content, Map<String,Object> meta)	Creates an instance of a ElicitResult record class.

Method Summary

Modifier and Type	Method	Description
McpSchema.ElicitResult.Action	action()	Returns the value of the action record component.
static McpSchema.ElicitResult.Builder	builder()
Map<String,Object>	content()	Returns the value of the content record component.
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.
Map<String,Object>	meta()	Returns the value of the meta 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

Constructor Details

ElicitResult

public ElicitResult(McpSchema.ElicitResult.Action action,
 Map<String,Object> content)

ElicitResult

public ElicitResult(McpSchema.ElicitResult.Action action,
 Map<String,Object> content,
 Map<String,Object> meta)

Creates an instance of a ElicitResult record class.

Parameters:

action - the value for the action record component

content - the value for the content record component

meta - the value for the meta record component

Method Details

builder

public static McpSchema.ElicitResult.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.

action

public McpSchema.ElicitResult.Action action()

Returns the value of the action record component.

Returns:

the value of the action record component

content

public Map<String,Object> content()

Returns the value of the content record component.

Returns:

the value of the content record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Result

Returns:

the value of the meta record component