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

Interface Groups

All Known Implementing Classes:

Groups.NotImplemented

public interface Groups

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Groups.ListRequest
static class	Groups.NotImplemented	A default implementation which allows source compatibility when adding new methods to the interface.
static class	Groups.QueryRequest	API for setting parameters and getting result.

Method Summary

Modifier and Type	Method	Description
GroupApi	create(GroupInput input)	Create a new group.
GroupApi	create(String name)	Create a new group with the given name and default options.
GroupApi	id(String id)	Look up a group by ID.
Groups.ListRequest	list()
Groups.QueryRequest	query()	Query groups.
Groups.QueryRequest	query(String query)	Query groups.

Method Detail

id

GroupApi id(String id)
     throws RestApiException

Look up a group by ID.

Note: This method eagerly reads the group. Methods that mutate the group do not necessarily re-read the group. Therefore, calling a getter method on an instance after calling a mutation method on that same instance is not guaranteed to reflect the mutation. It is not recommended to store references to groupApi instances.

Parameters:

id - any identifier supported by the REST API, including group name or UUID.

Returns:

API for accessing the group.

Throws:

RestApiException - if an error occurred.

create

GroupApi create(String name)
         throws RestApiException

Create a new group with the given name and default options.

Throws:

RestApiException

create

GroupApi create(GroupInput input)
         throws RestApiException

Create a new group.

Throws:

RestApiException

list

Groups.ListRequest list()

Returns:

new request for listing groups.

query

Groups.QueryRequest query()

Query groups.

Example code: query().withQuery("inname:test").withLimit(10).get()

Returns:

API for setting parameters and getting result.

query

Groups.QueryRequest query(String query)

Query groups.

Shortcut API for query().withQuery(String).

See Also:

query()