Package com.github.copilot.sdk.json

Record Class Attachment

java.lang.Object

java.lang.Record

com.github.copilot.sdk.json.Attachment

Record Components:

type - the attachment type (e.g., "file")

path - the absolute path to the file on the filesystem

displayName - a human-readable display name for the attachment

public record Attachment(String type, String path, String displayName)
extends Record

Represents a file attachment to include with a message.

Attachments provide additional context to the AI assistant, such as source code files, documents, or other relevant content.

Example Usage

 var attachment = new Attachment("file", "/path/to/source.java", "Main Source File");
 

Since:

1.0.0

See Also:

• MessageOptions.setAttachments(java.util.List)

Constructor Summary

Constructors

Constructor	Description
Attachment(String type, String path, String displayName)	Creates an instance of a Attachment record class.

Method Summary

Modifier and Type	Method	Description
String	displayName()	Returns the value of the displayName 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	path()	Returns the value of the path record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Attachment

public Attachment(String type,
 String path,
 String displayName)

Creates an instance of a Attachment record class.

Parameters:

type - the value for the type record component

path - the value for the path record component

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

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

path

public String path()

Returns the value of the path record component.

Returns:

the value of the path record component

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component