Package com.google.gerrit.extensions.api.groups

Class Groups.QueryRequest

java.lang.Object

com.google.gerrit.extensions.api.groups.Groups.QueryRequest

Enclosing interface:

Groups

public abstract static class Groups.QueryRequest
extends Object

API for setting parameters and getting result. Used for query().

See Also:

• Groups.query()

Constructor Summary

Constructors

Constructor	Description
QueryRequest()

Method Summary

Modifier and Type	Method	Description
abstract List<GroupInfo>	get()	Execute query and returns the matched groups as list.
int	getLimit()
Set<ListGroupsOption>	getOptions()
String	getQuery()
int	getStart()
Groups.QueryRequest	withLimit(int limit)	Set limit for returned list of groups.
Groups.QueryRequest	withOption(ListGroupsOption options)	Set an option on the request, appending to existing options.
Groups.QueryRequest	withOptions(ListGroupsOption... options)	Set options on the request, appending to existing options.
Groups.QueryRequest	withOptions(Set<ListGroupsOption> options)	Set options on the request, replacing existing options.
Groups.QueryRequest	withQuery(String query)	Set query.
Groups.QueryRequest	withStart(int start)	Set number of groups to skip.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueryRequest

public QueryRequest()

Method Details

get

public abstract List<GroupInfo> get()
                             throws RestApiException

Execute query and returns the matched groups as list.

Throws:

RestApiException

withQuery

public Groups.QueryRequest withQuery(String query)

Set query.

Parameters:

query - needs to be in human-readable form.

withLimit

public Groups.QueryRequest withLimit(int limit)

Set limit for returned list of groups. Optional; server-default is used when not provided.

withStart

public Groups.QueryRequest withStart(int start)

Set number of groups to skip. Optional; no groups are skipped when not provided.

withOption

public Groups.QueryRequest withOption(ListGroupsOption options)

Set an option on the request, appending to existing options.

withOptions

public Groups.QueryRequest withOptions(ListGroupsOption... options)

Set options on the request, appending to existing options.

withOptions

public Groups.QueryRequest withOptions(Set<ListGroupsOption> options)

Set options on the request, replacing existing options.

getQuery

public String getQuery()

getLimit

public int getLimit()

getStart

public int getStart()

getOptions

public Set<ListGroupsOption> getOptions()