Record Class SessionUiElicitationParams

java.lang.Object

java.lang.Record

com.github.copilot.generated.rpc.SessionUiElicitationParams

@CopilotExperimental
@Generated("copilot-sdk-codegen")
public record SessionUiElicitationParams(String sessionId, McpElicitationFormMode mode, String message, UIElicitationSchema requestedSchema, Map<String,Object> meta, McpTaskMetadata task)
extends Record

Prompt message and JSON schema describing the form fields to elicit from the user.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
SessionUiElicitationParams(String sessionId, McpElicitationFormMode mode, String message, UIElicitationSchema requestedSchema, Map<String,Object> meta, McpTaskMetadata task)	Creates an instance of a SessionUiElicitationParams record class.

Method Summary

Modifier and Type	Method	Description
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.
McpElicitationFormMode	mode()	Returns the value of the mode record component.
UIElicitationSchema	requestedSchema()	Returns the value of the requestedSchema record component.
String	sessionId()	Returns the value of the sessionId record component.
McpTaskMetadata	task()	Returns the value of the task record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SessionUiElicitationParams

public SessionUiElicitationParams(String sessionId,
 McpElicitationFormMode mode,
 String message,
 UIElicitationSchema requestedSchema,
 Map<String,Object> meta,
 McpTaskMetadata task)

Creates an instance of a SessionUiElicitationParams record class.

Parameters:

sessionId - the value for the sessionId record component

mode - the value for the mode record component

message - the value for the message record component

requestedSchema - the value for the requestedSchema record component

meta - the value for the meta record component

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

sessionId

public String sessionId()

Returns the value of the sessionId record component.

Returns:

the value of the sessionId record component

mode

public McpElicitationFormMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

requestedSchema

public UIElicitationSchema 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.

Returns:

the value of the meta record component

task

public McpTaskMetadata task()

Returns the value of the task record component.

Returns:

the value of the task record component