Record Class CitationSource

java.lang.Object

java.lang.Record

com.github.copilot.generated.CitationSource

@Generated("copilot-sdk-codegen")
public record CitationSource(String id, CitationProvider provider, String title, String url, String path)
extends Record

A source that backs one or more cited spans in the assistant's response.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
CitationSource(String id, CitationProvider provider, String title, String url, String path)	Creates an instance of a CitationSource 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	id()	Returns the value of the id record component.
String	path()	Returns the value of the path record component.
CitationProvider	provider()	Returns the value of the provider record component.
String	title()	Returns the value of the title 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 Object

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

Constructor Details

CitationSource

public CitationSource(String id,
 CitationProvider provider,
 String title,
 String url,
 String path)

Creates an instance of a CitationSource record class.

Parameters:

id - the value for the id record component

provider - the value for the provider record component

title - the value for the title record component

url - the value for the url record component

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

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

provider

public CitationProvider provider()

Returns the value of the provider record component.

Returns:

the value of the provider record component

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

path

public String path()

Returns the value of the path record component.

Returns:

the value of the path record component