Package com.azure.storage.blob.changefeed

Class BlobChangefeedClient

  • public class BlobChangefeedClient
extends Object
    This class provides a client that contains all operations that apply to Azure Storage Blob changefeed.
    See Also:
    BlobChangefeedClientBuilder

    • Method Detail

      • getEvents

        public BlobChangefeedPagedIterable getEvents()
        Returns a lazy loaded list of changefeed events for this account. The returned BlobChangefeedPagedIterable can be consumed through while new items are automatically retrieved as needed.

        Changefeed events are returned in approximate temporal order.

        For more information, see the Azure Docs.

        Code Samples

         client.getEvents().forEach(event ->
     System.out.printf("Topic: %s, Subject: %s%n", event.getTopic(), event.getSubject()));
        Returns:
        The changefeed events.

      • getEvents

        public BlobChangefeedPagedIterable getEvents​(OffsetDateTime startTime,
                                             OffsetDateTime endTime)
        Returns a lazy loaded list of changefeed events for this account. The returned BlobChangefeedPagedIterable can be consumed through while new items are automatically retrieved as needed.

        Changefeed events are returned in approximate temporal order.

        For more information, see the Azure Docs.

        Code Samples

         OffsetDateTime startTime = OffsetDateTime.MIN;
 OffsetDateTime endTime = OffsetDateTime.now();

 client.getEvents(startTime, endTime).forEach(event ->
     System.out.printf("Topic: %s, Subject: %s%n", event.getTopic(), event.getSubject()));
        Parameters:
        startTime - Filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour.
        endTime - Filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour.
        Returns:
        The changefeed events.

      • getEvents

        public BlobChangefeedPagedIterable getEvents​(OffsetDateTime startTime,
                                             OffsetDateTime endTime,
                                             com.azure.core.util.Context context)
        Returns a lazy loaded list of changefeed events for this account. The returned BlobChangefeedPagedIterable can be consumed through while new items are automatically retrieved as needed.

        Changefeed events are returned in approximate temporal order.

        For more information, see the Azure Docs.

        Code Samples

         OffsetDateTime startTime = OffsetDateTime.MIN;
 OffsetDateTime endTime = OffsetDateTime.now();

 client.getEvents(startTime, endTime, new Context("key", "value")).forEach(event ->
     System.out.printf("Topic: %s, Subject: %s%n", event.getTopic(), event.getSubject()));
        Parameters:
        startTime - Filters the results to return events approximately after the start time. Note: A few events belonging to the previous hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the start time down by an hour.
        endTime - Filters the results to return events approximately before the end time. Note: A few events belonging to the next hour can also be returned. A few events belonging to this hour can be missing; to ensure all events from the hour are returned, round the end time up by an hour.
        context - Additional context that is passed through the Http pipeline during the service call.
        Returns:
        The changefeed events.

      • getEvents

        public BlobChangefeedPagedIterable getEvents​(String cursor)
        Returns a lazy loaded list of changefeed events for this account. The returned BlobChangefeedPagedIterable can be consumed through while new items are automatically retrieved as needed.

        Changefeed events are returned in approximate temporal order.

        For more information, see the Azure Docs.

        Code Samples

         String cursor = "cursor";

 client.getEvents(cursor).forEach(event ->
     System.out.printf("Topic: %s, Subject: %s%n", event.getTopic(), event.getSubject()));
        Parameters:
        cursor - Identifies the portion of the events to be returned with the next get operation. Events that take place after the event identified by the cursor will be returned.
        Returns:
        The changefeed events.

      • getEvents

        public BlobChangefeedPagedIterable getEvents​(String cursor,
                                             com.azure.core.util.Context context)
        Returns a lazy loaded list of changefeed events for this account. The returned BlobChangefeedPagedIterable can be consumed through while new items are automatically retrieved as needed.

        Changefeed events are returned in approximate temporal order.

        For more information, see the Azure Docs.

        Code Samples

         String cursor = "cursor";

 client.getEvents(cursor, new Context("key", "value")).forEach(event ->
     System.out.printf("Topic: %s, Subject: %s%n", event.getTopic(), event.getSubject()));
        Parameters:
        cursor - Identifies the portion of the events to be returned with the next get operation. Events that take place after the event identified by the cursor will be returned.
        context - Additional context that is passed through the Http pipeline during the service call.
        Returns:
        The changefeed events.