com.azure.storage.blob.changefeed.BlobChangefeedPagedResponse Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.storage.blob.changefeed;

import com.azure.core.util.IterableStream;
import com.azure.core.util.paging.ContinuablePage;
import com.azure.storage.blob.changefeed.implementation.models.ChangefeedCursor;
import com.azure.storage.blob.changefeed.models.BlobChangefeedEvent;

import java.util.List;

/**
 * Represents a page returned in BlobChangefeed.
 *
 * A {@link BlobChangefeedPagedResponse} consists of {@link BlobChangefeedEvent} elements and {@link String}
 * cursor. 
 *
 * A cursor can be used to re-initialize a BlobChangefeed to point to the next expected page. 
 *
 * @see BlobChangefeedPagedFlux
 * @see BlobChangefeedPagedIterable
 */
public class BlobChangefeedPagedResponse implements ContinuablePage {

    private final List events;
    private final ChangefeedCursor cursor;

    /**
     * Package-private constructor for use by {@link BlobChangefeedPagedFlux}
     * @param events A {@link List} of {@link BlobChangefeedEvent BlobChangefeedEvents}.
     * @param cursor A {@link ChangefeedCursor cursor}.
     */
    BlobChangefeedPagedResponse(List events, ChangefeedCursor cursor) {
        this.events = events;
        this.cursor = cursor;
    }

    /**
     * {@inheritDoc}
     */
    public IterableStream getElements() {
        return new IterableStream<>(this.events);
    }

    /**
     * Gets a {@link List} of elements in the page.
     *
     * @return A {@link List} containing the elements in the page.
     */
    public List getValue() {
        return this.events;
    }

    /**
     * Gets a reference to the next page, should you want to re-initialize the BlobChangefeed.
     * To resume with the continuation token, call {@link BlobChangefeedAsyncClient#getEvents(String)} or
     * {@link BlobChangefeedClient#getEvents(String)}.
     *
     * @return The {@link String cursor} that references the next page.
     */
    public String getContinuationToken() {
        /* Serialize the cursor and return it to the user as a String. */
        return cursor.serialize();
    }
}