Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.CompleteRequest

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.CompleteRequest

Record Components:

ref - A reference to a prompt or resource template definition

argument - The argument's information for completion requests

meta - See specification for notes on _meta usage

context - Additional, optional context for completions

All Implemented Interfaces:

McpSchema.Request

Enclosing class:

McpSchema

public static record McpSchema.CompleteRequest(McpSchema.CompleteReference ref, McpSchema.CompleteRequest.CompleteArgument argument, Map<String,Object> meta, McpSchema.CompleteRequest.CompleteContext context)
extends Record
implements McpSchema.Request

A request from the client to the server, to ask for completion options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	McpSchema.CompleteRequest.CompleteArgument	The argument's information for completion requests.
static final record	McpSchema.CompleteRequest.CompleteContext	Additional, optional context for completions.

Constructor Summary

Constructors

Constructor	Description
CompleteRequest(McpSchema.CompleteReference ref, McpSchema.CompleteRequest.CompleteArgument argument)
CompleteRequest(McpSchema.CompleteReference ref, McpSchema.CompleteRequest.CompleteArgument argument, McpSchema.CompleteRequest.CompleteContext context)
CompleteRequest(McpSchema.CompleteReference ref, McpSchema.CompleteRequest.CompleteArgument argument, Map<String,Object> meta)
CompleteRequest(McpSchema.CompleteReference ref, McpSchema.CompleteRequest.CompleteArgument argument, Map<String,Object> meta, McpSchema.CompleteRequest.CompleteContext context)	Creates an instance of a CompleteRequest record class.

Method Summary

Modifier and Type	Method	Description
McpSchema.CompleteRequest.CompleteArgument	argument()	Returns the value of the argument record component.
McpSchema.CompleteRequest.CompleteContext	context()	Returns the value of the context 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.
McpSchema.CompleteReference	ref()	Returns the value of the ref 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

CompleteRequest

public CompleteRequest(McpSchema.CompleteReference ref,
 McpSchema.CompleteRequest.CompleteArgument argument,
 Map<String,Object> meta)

CompleteRequest

public CompleteRequest(McpSchema.CompleteReference ref,
 McpSchema.CompleteRequest.CompleteArgument argument,
 McpSchema.CompleteRequest.CompleteContext context)

CompleteRequest

public CompleteRequest(McpSchema.CompleteReference ref,
 McpSchema.CompleteRequest.CompleteArgument argument)

CompleteRequest

public CompleteRequest(McpSchema.CompleteReference ref,
 McpSchema.CompleteRequest.CompleteArgument argument,
 Map<String,Object> meta,
 McpSchema.CompleteRequest.CompleteContext context)

Creates an instance of a CompleteRequest record class.

Parameters:

ref - the value for the ref record component

argument - the value for the argument record component

meta - the value for the meta record component

context - the value for the context 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.

ref

public McpSchema.CompleteReference ref()

Returns the value of the ref record component.

Returns:

the value of the ref record component

argument

public McpSchema.CompleteRequest.CompleteArgument argument()

Returns the value of the argument record component.

Returns:

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

context

public McpSchema.CompleteRequest.CompleteContext context()

Returns the value of the context record component.

Returns:

the value of the context record component