Record Class ToolExecutionStartShellToolInfo

java.lang.Object

java.lang.Record

com.github.copilot.generated.ToolExecutionStartShellToolInfo

@Generated("copilot-sdk-codegen")
public record ToolExecutionStartShellToolInfo(List<String> possiblePaths, Boolean hasWriteFileRedirection, String displayCommand)
extends Record

Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
ToolExecutionStartShellToolInfo(List<String> possiblePaths, Boolean hasWriteFileRedirection, String displayCommand)	Creates an instance of a ToolExecutionStartShellToolInfo record class.

Method Summary

Modifier and Type	Method	Description
String	displayCommand()	Returns the value of the displayCommand 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.
Boolean	hasWriteFileRedirection()	Returns the value of the hasWriteFileRedirection record component.
List<String>	possiblePaths()	Returns the value of the possiblePaths record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ToolExecutionStartShellToolInfo

public ToolExecutionStartShellToolInfo(List<String> possiblePaths,
 Boolean hasWriteFileRedirection,
 String displayCommand)

Creates an instance of a ToolExecutionStartShellToolInfo record class.

Parameters:

possiblePaths - the value for the possiblePaths record component

hasWriteFileRedirection - the value for the hasWriteFileRedirection record component

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

possiblePaths

public List<String> possiblePaths()

Returns the value of the possiblePaths record component.

Returns:

the value of the possiblePaths record component

hasWriteFileRedirection

public Boolean hasWriteFileRedirection()

Returns the value of the hasWriteFileRedirection record component.

Returns:

the value of the hasWriteFileRedirection record component

displayCommand

public String displayCommand()

Returns the value of the displayCommand record component.

Returns:

the value of the displayCommand record component