Class TrelloBoardsReader
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.trello.TrelloApiReader
com.northconcepts.datapipeline.trello.TrelloBoardsReader
Reads the list of Trello boards belonging to a member (or the current member if non are specified).
-
Nested Class Summary
Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State -
Field Summary
Fields inherited from class com.northconcepts.datapipeline.trello.TrelloApiReader
trelloStubFields inherited from class com.northconcepts.datapipeline.core.DataReader
fieldLineage, recordLineageFields inherited from class com.northconcepts.datapipeline.core.DataEndpoint
lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEYFields inherited from class com.northconcepts.datapipeline.core.Endpoint
BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZEFields inherited from class com.northconcepts.datapipeline.core.DataObject
id, log, name, TIMESTAMP_FORMAT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddExceptionProperties(DataException exception) Adds this endpoint's current state to aDataException.Returns the filters selecting which boards are read (defaults toBoardFilter.ALL); null or empty also means ALL.getLists()Returns which of each board's lists are requested (defaults toBoardLists.NONE).Returns the ID of the member whose boards are read (defaults to"me").protected ArrayValueFetches the next page of items as records usingtrelloStub; each item needs anidfield and a page smaller thanTrelloApiReader.getBatchSize()ends the read.setFilter(BoardFilter... filter) Replaces the filters selecting which boards are read with the given values.setFilter(EnumSet<BoardFilter> filter) Sets the filters selecting which boards are read (defaults toBoardFilter.ALL); null or empty also means ALL.setLists(BoardLists lists) Sets which of each board's lists are requested; null meansBoardLists.NONE, the default.setMemberId(String memberId) Sets the ID of the member whose boards are read; null or empty means"me", the default.Methods inherited from class com.northconcepts.datapipeline.trello.TrelloApiReader
close, getBatchSize, getBefore, getSince, open, readImpl, setBefore, setSinceMethods inherited from class com.northconcepts.datapipeline.core.DataReader
addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skipMethods inherited from class com.northconcepts.datapipeline.core.DataEndpoint
decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toStringMethods 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
-
Constructor Details
-
TrelloBoardsReader
-
-
Method Details
-
getMemberId
Returns the ID of the member whose boards are read (defaults to"me"). -
setMemberId
Sets the ID of the member whose boards are read; null or empty means"me", the default. -
getFilter
Returns the filters selecting which boards are read (defaults toBoardFilter.ALL); null or empty also means ALL. -
setFilter
Sets the filters selecting which boards are read (defaults toBoardFilter.ALL); null or empty also means ALL. -
setFilter
Replaces the filters selecting which boards are read with the given values. -
getLists
Returns which of each board's lists are requested (defaults toBoardLists.NONE). -
setLists
Sets which of each board's lists are requested; null meansBoardLists.NONE, the default. -
readNextBatchImpl
Description copied from class:TrelloApiReaderFetches the next page of items as records usingtrelloStub; each item needs anidfield and a page smaller thanTrelloApiReader.getBatchSize()ends the read.- Specified by:
readNextBatchImplin classTrelloApiReader
-
addExceptionProperties
Description copied from class:EndpointAdds this endpoint's current state to aDataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.- Overrides:
addExceptionPropertiesin classTrelloApiReader
-