Package com.github.copilot.sdk.json

Record Class PostToolUseHookOutput

java.lang.Object

java.lang.Record

com.github.copilot.sdk.json.PostToolUseHookOutput

Record Components:

modifiedResult - the modified tool result, or null to use original

additionalContext - additional context to provide to the model

suppressOutput - true to suppress output

public record PostToolUseHookOutput(com.fasterxml.jackson.databind.JsonNode modifiedResult, String additionalContext, Boolean suppressOutput)
extends Record

Output for a post-tool-use hook.

Since:

1.0.6

Constructor Summary

Constructors

Constructor	Description
PostToolUseHookOutput(com.fasterxml.jackson.databind.JsonNode modifiedResult, String additionalContext, Boolean suppressOutput)	Creates an instance of a PostToolUseHookOutput record class.

Method Summary

Modifier and Type	Method	Description
String	additionalContext()	Returns the value of the additionalContext 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.
com.fasterxml.jackson.databind.JsonNode	modifiedResult()	Returns the value of the modifiedResult record component.
Boolean	suppressOutput()	Returns the value of the suppressOutput record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PostToolUseHookOutput

public PostToolUseHookOutput(com.fasterxml.jackson.databind.JsonNode modifiedResult,
 String additionalContext,
 Boolean suppressOutput)

Creates an instance of a PostToolUseHookOutput record class.

Parameters:

modifiedResult - the value for the modifiedResult record component

additionalContext - the value for the additionalContext record component

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

modifiedResult

public com.fasterxml.jackson.databind.JsonNode modifiedResult()

Returns the value of the modifiedResult record component.

Returns:

the value of the modifiedResult record component

additionalContext

public String additionalContext()

Returns the value of the additionalContext record component.

Returns:

the value of the additionalContext record component

suppressOutput

public Boolean suppressOutput()

Returns the value of the suppressOutput record component.

Returns:

the value of the suppressOutput record component