Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,27 @@ while (users.hasNext()) {
}
```

### Accessing pagination metadata

List responses are wrapped in a metadata envelope (`total`, `start`, `limit`, `length`, etc.).
The items come from the iterable as usual; the envelope is read via `getResponse()`, typed to
the endpoint's response class (for users, `ListUsersOffsetPaginatedResponseContent`):

```java
SyncPagingIterable<UserResponseSchema> page = client.users().list(
ListUsersRequestParameters.builder().perPage(50).build()
);

Optional<ListUsersOffsetPaginatedResponseContent> listUsersOffsetPaginatedResponseContentOptional = resp.getResponse();
listUsersOffsetPaginatedResponseContentOptional.ifPresent(m -> {
m.getTotal().ifPresent(total -> System.out.println("total: " + total));
m.getStart().ifPresent(start -> System.out.println("start: " + start));
m.getLimit().ifPresent(limit -> System.out.println("limit: " + limit));
m.getLength().ifPresent(length -> System.out.println("length: " + length));
});

```

### Accessing raw HTTP responses

Use `withRawResponse()` to access HTTP response metadata:
Expand Down
Loading