Package com.github.copilot.sdk.generated

Record Class ElicitationRequestedEvent.ElicitationRequestedEventData

java.lang.Object

java.lang.Record

com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData

Enclosing class:

ElicitationRequestedEvent

public static record ElicitationRequestedEvent.ElicitationRequestedEventData(String requestId, String toolCallId, String elicitationSource, String message, ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataMode mode, ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchema requestedSchema, String url)
extends Record

Data payload for ElicitationRequestedEvent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataMode	Elicitation mode; "form" for structured input, "url" for browser-based.
static final record	ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchema	JSON Schema describing the form fields to present to the user (form mode only)

Constructor Summary

Constructors

Constructor	Description
ElicitationRequestedEventData(String requestId, String toolCallId, String elicitationSource, String message, ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataMode mode, ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchema requestedSchema, String url)	Creates an instance of a ElicitationRequestedEventData record class.

Method Summary

Modifier and Type	Method	Description
String	elicitationSource()	Returns the value of the elicitationSource 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.
String	message()	Returns the value of the message record component.
ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataMode	mode()	Returns the value of the mode record component.
ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchema	requestedSchema()	Returns the value of the requestedSchema record component.
String	requestId()	Returns the value of the requestId record component.
String	toolCallId()	Returns the value of the toolCallId record component.
final String	toString()	Returns a string representation of this record class.
String	url()	Returns the value of the url record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ElicitationRequestedEventData

public ElicitationRequestedEventData(String requestId,
 String toolCallId,
 String elicitationSource,
 String message,
 ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataMode mode,
 ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchema requestedSchema,
 String url)

Creates an instance of a ElicitationRequestedEventData record class.

Parameters:

requestId - the value for the requestId record component

toolCallId - the value for the toolCallId record component

elicitationSource - the value for the elicitationSource record component

message - the value for the message record component

mode - the value for the mode record component

requestedSchema - the value for the requestedSchema record component

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

requestId

public String requestId()

Returns the value of the requestId record component.

Returns:

the value of the requestId record component

toolCallId

public String toolCallId()

Returns the value of the toolCallId record component.

Returns:

the value of the toolCallId record component

elicitationSource

public String elicitationSource()

Returns the value of the elicitationSource record component.

Returns:

the value of the elicitationSource record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

mode

public ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

requestedSchema

public ElicitationRequestedEvent.ElicitationRequestedEventData.ElicitationRequestedEventDataRequestedSchema requestedSchema()

Returns the value of the requestedSchema record component.

Returns:

the value of the requestedSchema record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component