Class JiraSprintReader
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.jira.JiraReader
com.northconcepts.datapipeline.jira.JiraSprintReader
Reads Jira sprints from a board based on the API user's permission.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe sprint states aJiraSprintReadercan filter on;ALLsends no state filter.Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State -
Field Summary
Fields 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
ConstructorsConstructorDescriptionJiraSprintReader(String domain, String username, String apiKey, int boardId) Creates a reader for the sprints of the given board;domainis the Jira site's base URL. -
Method Summary
Modifier and TypeMethodDescriptionaddExceptionProperties(DataException exception) Adds this endpoint's current state to aDataException.protected RecordFetches the next page as a record with anisLastflag and the item array (namedvaluesunless changed byJiraReader.setRecordsFieldName(String)), or returns null to end the read.Indicates the state to filter sprints on (default is ACTIVE).setSprintState(JiraSprintReader.SprintState sprintState) Indicates the state to filter sprints on (default is ACTIVE).Methods inherited from class com.northconcepts.datapipeline.jira.JiraReader
close, getBatchSize, getClient, getMaxItems, getPageOffset, getTotalItems, open, readImpl, readNextBatch, setBatchSize, setIssuesRecord, setMaxItems, setPageOffset, setRecordsFieldName, setTotalItemsMethods 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
-
JiraSprintReader
Creates a reader for the sprints of the given board;domainis the Jira site's base URL.
-
-
Method Details
-
getSprintState
Indicates the state to filter sprints on (default is ACTIVE). -
setSprintState
Indicates the state to filter sprints on (default is ACTIVE). -
getIssuesRecord
Description copied from class:JiraReaderFetches the next page as a record with anisLastflag and the item array (namedvaluesunless changed byJiraReader.setRecordsFieldName(String)), or returns null to end the read.- Specified by:
getIssuesRecordin classJiraReader
-
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 classJiraReader
-