Record Class CatalogSearchParams

java.lang.Object

java.lang.Record

com.github.copilot.generated.rpc.CatalogSearchParams

@CopilotExperimental
@Generated("copilot-sdk-codegen")
public record CatalogSearchParams(CatalogClientContract contract, String query, Long limit, List<CatalogCandidateKind> kinds, CatalogSearchPage page)
extends Record

A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
CatalogSearchParams(CatalogClientContract contract, String query, Long limit, List<CatalogCandidateKind> kinds, CatalogSearchPage page)	Creates an instance of a CatalogSearchParams record class.

Method Summary

Modifier and Type	Method	Description
CatalogClientContract	contract()	Returns the value of the contract 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.
List<CatalogCandidateKind>	kinds()	Returns the value of the kinds record component.
Long	limit()	Returns the value of the limit record component.
CatalogSearchPage	page()	Returns the value of the page record component.
String	query()	Returns the value of the query record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CatalogSearchParams

public CatalogSearchParams(CatalogClientContract contract,
 String query,
 Long limit,
 List<CatalogCandidateKind> kinds,
 CatalogSearchPage page)

Creates an instance of a CatalogSearchParams record class.

Parameters:

contract - the value for the contract record component

query - the value for the query record component

limit - the value for the limit record component

kinds - the value for the kinds record component

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

contract

public CatalogClientContract contract()

Returns the value of the contract record component.

Returns:

the value of the contract record component

query

public String query()

Returns the value of the query record component.

Returns:

the value of the query record component

limit

public Long limit()

Returns the value of the limit record component.

Returns:

the value of the limit record component

kinds

public List<CatalogCandidateKind> kinds()

Returns the value of the kinds record component.

Returns:

the value of the kinds record component

page

public CatalogSearchPage page()

Returns the value of the page record component.

Returns:

the value of the page record component