GetGroupsQueryParams (Box Java SDK)

Object
- GetGroupsQueryParams

public class GetGroupsQueryParams
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GetGroupsQueryParams.Builder

Field Summary

Fields
Modifier and Type	Field and Description
`List<String>`	`fields` A comma-separated list of attributes to include in the response.
`String`	`filterTerm` Limits the results to only groups whose `name` starts with the search term.
`Long`	`limit` The maximum number of items to return per page.
`Long`	`offset` The offset of the item at which to begin the response.

Constructor Summary

Constructors
Modifier Constructor and Description

GetGroupsQueryParams()

protected GetGroupsQueryParams(GetGroupsQueryParams.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

List<String> getFields()

String getFilterTerm()

Long getLimit()

Long getOffset()
- Methods inherited from class Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - filterTerm
```
public String filterTerm
```
    Limits the results to only groups whose `name` starts with the search term.
  - fields
```
public List<String> fields
```
    A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
    Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
  - limit
```
public Long limit
```
    The maximum number of items to return per page.
  - offset
```
public Long offset
```
    The offset of the item at which to begin the response.
    Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
- Constructor Detail
  - GetGroupsQueryParams
```
public GetGroupsQueryParams()
```
  - GetGroupsQueryParams
```
protected GetGroupsQueryParams(GetGroupsQueryParams.Builder builder)
```
- Method Detail
  - getFilterTerm
```
public String getFilterTerm()
```
  - getFields
```
public List<String> getFields()
```
  - getLimit
```
public Long getLimit()
```
  - getOffset
```
public Long getOffset()
```