com.northconcepts.datapipeline.google.gmail

Class GmailMessageReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.internal.lang.IntegrationReader

com.northconcepts.datapipeline.google.GoogleApiReader

com.northconcepts.datapipeline.google.gmail.GmailMessageReader

public class GmailMessageReader
extends GoogleApiReader

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BATCH_SIZE
static int	MIN_BATCH_SIZE

Fields inherited from class com.northconcepts.datapipeline.google.GoogleApiReader

credentials, JSON_FACTORY, transport

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
GmailMessageReader(Credential credentials)
GmailMessageReader(Credential credential, HttpTransport httpTransport)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
GmailMessageReader	addLabelIds(String... labelIds)
int	available() Returns the number of records that can probably be read without blocking.
void	close() Indicates that this endpoint has finished reading or writing.
int	getBatchSize()
List<String>	getLabelIds()
String	getQuery()
boolean	isIncludeSpamAndTrash()
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
GmailMessageReader	setBatchSize(int batchSize)
GmailMessageReader	setIncludeSpamAndTrash(boolean includeSpamAndTrash)
GmailMessageReader	setQuery(String query)

Methods inherited from class com.northconcepts.datapipeline.google.GoogleApiReader

getApplicationName, setApplicationName, setJsonFactory, toDate, toException

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

addLineage, getBufferSize, getNestedEndpoint, getNestedReader, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MIN_BATCH_SIZE

public static final int MIN_BATCH_SIZE

See Also:

Constant Field Values

MAX_BATCH_SIZE

public static final int MAX_BATCH_SIZE

See Also:

Constant Field Values

Constructor Detail

GmailMessageReader

public GmailMessageReader(Credential credential,
                          HttpTransport httpTransport)

GmailMessageReader

public GmailMessageReader(Credential credentials)

Method Detail

getQuery

public String getQuery()

setQuery

public GmailMessageReader setQuery(String query)

getBatchSize

public int getBatchSize()

isIncludeSpamAndTrash

public boolean isIncludeSpamAndTrash()

setIncludeSpamAndTrash

public GmailMessageReader setIncludeSpamAndTrash(boolean includeSpamAndTrash)

getLabelIds

public List<String> getLabelIds()

addLabelIds

public GmailMessageReader addLabelIds(String... labelIds)

setBatchSize

public GmailMessageReader setBatchSize(int batchSize)

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 GoogleApiReader

Throws:

DataException

available

public int available()
              throws DataException

Description copied from class: DataReader

Returns the number of records that can probably be read without blocking.

Overrides:

available in class DataReader

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.

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 GoogleApiReader