Interface SearchParameters
-
- All Superinterfaces:
Parameters
- All Known Implementing Classes:
ImmutableSearchParameters
@Immutable public interface SearchParameters extends Parameters
Search parameters resource defines required and optional parameters. To be serialized as key=value.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Optional<String>
order()
The sort order if sort parameter is provided.Optional<Integer>
page()
Page number of the results to fetch.Optional<Integer>
per_page()
The number of results per page (max 100).String
q()
The search keywords, as well as any qualifiers.Optional<String>
sort()
The sort field.-
Methods inherited from interface com.spotify.github.Parameters
serialize
-
-
-
-
Method Detail
-
q
@Nullable String q()
The search keywords, as well as any qualifiers.
-
sort
Optional<String> sort()
The sort field. One of stars, forks, or updated. Default: results are sorted by best match.
-
order
Optional<String> order()
The sort order if sort parameter is provided. One of asc or desc. Default: desc
-
-