Java SDK pagination - Telnyx

Pagination

The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.

Auto-pagination

To iterate through all results across all pages, use the autoPager() method, which automatically fetches more pages as needed. When using the synchronous client, the method returns an Iterable

import com.telnyx.sdk.models.accessipaddress.AccessIpAddressListPage;
import com.telnyx.sdk.models.accessipaddress.AccessIpAddressResponse;

AccessIpAddressListPage page = client.accessIpAddress().list();

// Process as an Iterable
for (AccessIpAddressResponse accessIpAddress : page.autoPager()) {
    System.out.println(accessIpAddress);
}

// Process as a Stream
page.autoPager()
    .stream()
    .limit(50)
    .forEach(accessIpAddress -> System.out.println(accessIpAddress));

When using the asynchronous client, the method returns an AsyncStreamResponse:

import com.telnyx.sdk.core.http.AsyncStreamResponse;
import com.telnyx.sdk.models.accessipaddress.AccessIpAddressListPageAsync;
import com.telnyx.sdk.models.accessipaddress.AccessIpAddressResponse;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

CompletableFuture<AccessIpAddressListPageAsync> pageFuture = client.async().accessIpAddress().list();

pageFuture.thenRun(page -> page.autoPager().subscribe(accessIpAddress -> {
    System.out.println(accessIpAddress);
}));

// If you need to handle errors or completion of the stream
pageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {
    @Override
    public void onNext(AccessIpAddressResponse accessIpAddress) {
        System.out.println(accessIpAddress);
    }

    @Override
    public void onComplete(Optional<Throwable> error) {
        if (error.isPresent()) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error.get());
        } else {
            System.out.println("No more!");
        }
    }
}));

// Or use futures
pageFuture.thenRun(page -> page.autoPager()
    .subscribe(accessIpAddress -> {
        System.out.println(accessIpAddress);
    })
    .onCompleteFuture()
    .whenComplete((unused, error) -> {
        if (error != null) {
            System.out.println("Something went wrong!");
            throw new RuntimeException(error);
        } else {
            System.out.println("No more!");
        }
    }));

Manual pagination

To access individual page items and manually request the next page, use the items(), hasNextPage(), and nextPage() methods:

import com.telnyx.sdk.models.accessipaddress.AccessIpAddressListPage;
import com.telnyx.sdk.models.accessipaddress.AccessIpAddressResponse;

AccessIpAddressListPage page = client.accessIpAddress().list();
while (true) {
    for (AccessIpAddressResponse accessIpAddress : page.items()) {
        System.out.println(accessIpAddress);
    }

    if (!page.hasNextPage()) {
        break;
    }

    page = page.nextPage();
}

⌘I