Class RoleListParams
-
- All Implemented Interfaces:
-
com.braintrustdata.api.core.Params
public final class RoleListParams implements Params
List out all roles. The roles are sorted by creation date, with the most recently-created roles coming first
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRoleListParams.BuilderA builder for RoleListParams.
public final classRoleListParams.IdsFilter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
-
Method Summary
Modifier and Type Method Description final Optional<String>endingBefore()Pagination cursor id. final Optional<RoleListParams.Ids>ids()Filter search results to a particular set of object IDs. final Optional<Long>limit()Limit the number of objects to return final Optional<String>orgName()Filter search results to within a particular organization final Optional<String>roleName()Name of the role to search for final Optional<String>startingAfter()Pagination cursor id. final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final RoleListParams.BuildertoBuilder()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static RoleListParamsnone()final static RoleListParams.Builderbuilder()Returns a mutable builder for constructing an instance of RoleListParams. -
-
Method Detail
-
endingBefore
final Optional<String> endingBefore()
Pagination cursor id.
For example, if the initial item in the last page you fetched had an id of
foo, passending_before=footo fetch the previous page. Note: you may only pass one ofstarting_afterandending_before
-
ids
final Optional<RoleListParams.Ids> ids()
Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times
-
startingAfter
final Optional<String> startingAfter()
Pagination cursor id.
For example, if the final item in the last page you fetched had an id of
foo, passstarting_after=footo fetch the next page. Note: you may only pass one ofstarting_afterandending_before
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final RoleListParams.Builder toBuilder()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static RoleListParams none()
-
builder
final static RoleListParams.Builder builder()
Returns a mutable builder for constructing an instance of RoleListParams.
-
-
-
-