Class MailChimpListMemberReader


public class MailChimpListMemberReader extends IntegrationReader
Reads the list of subscribed, unsubscribed, and cleaned members from a MailChimp list.
  • Constructor Details

    • MailChimpListMemberReader

      public MailChimpListMemberReader(String apiKey, String listId)
  • Method Details

    • getListId

      public String getListId()
    • getPageOffset

      public long getPageOffset()
      Returns the offset of the next page to request (defaults to 0); it grows by the number of members in each page read.
    • setPageOffset

      public MailChimpListMemberReader setPageOffset(long pageOffset)
      Sets the offset of the next page to request (defaults to 0); it grows by the number of members in each page read.
    • getPageSize

      public long getPageSize()
      Returns the number of members requested per page (defaults to 10).
    • setPageSize

      public MailChimpListMemberReader setPageSize(long pageSize)
      Sets the number of members requested per page (defaults to 10).
    • getStatus

      public ListMemberStatus getStatus()
      Returns the status used to filter the requested members or null (the default) to send no status filter.
    • setStatus

      public MailChimpListMemberReader setStatus(ListMemberStatus status)
      Sets the status used to filter the requested members or null (the default) to send no status filter.
    • open

      public void open() throws DataException
      Description copied from class: DataEndpoint
      Makes this endpoint ready for reading or writing.
      Overrides:
      open in class IntegrationReader
      Throws:
      DataException
    • close

      public void close() throws DataException
      Description copied from class: DataEndpoint
      Indicates that this endpoint has finished reading or writing.
      Overrides:
      close in class DataEndpoint
      Throws:
      DataException
    • readImpl

      protected Record readImpl() throws Throwable
      Description copied from class: DataReader
      Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

      If no record is available, null will be returned.

      Contract for subclasses (see also docs/authoring/DataReader.md):

      Specified by:
      readImpl in class DataReader
      Throws:
      Throwable
    • addExceptionProperties

      public DataException addExceptionProperties(DataException exception)
      Description copied from class: Endpoint
      Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.
      Overrides:
      addExceptionProperties in class DataReader