Groups.ListRequest, Groups.NotImplemented, Groups.QueryRequest
Constructor and Description |
---|
NotImplemented() |
Modifier and Type | Method and 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.
|
public GroupApi id(String id) throws RestApiException
Groups
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.
id
in interface Groups
id
- any identifier supported by the REST API, including group name or UUID.RestApiException
- if an error occurred.public GroupApi create(String name) throws RestApiException
Groups
create
in interface Groups
RestApiException
public GroupApi create(GroupInput input) throws RestApiException
Groups
create
in interface Groups
RestApiException
public Groups.ListRequest list()
public Groups.QueryRequest query()
Groups
Example code: query().withQuery("inname:test").withLimit(10).get()
public Groups.QueryRequest query(String query)
Groups
Shortcut API for query().withQuery(String)
.
query
in interface Groups
Groups.query()