Class GoogleContactsReader
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.contacts.GoogleContactsReader
Reads a Google account's contacts through the People API, one record per person with their names, email addresses, phone
numbers, addresses and other details.
-
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.google.GoogleApiReader
credentials, JSON_FACTORY, transportFields 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
ConstructorsConstructorDescriptionGoogleContactsReader(Credential credential, HttpTransport httpTransport) Creates a reader that uses the caller's transport, which is not shut down on close. -
Method Summary
Modifier and TypeMethodDescriptionaddExceptionProperties(DataException exception) Adds this endpoint's current state to aDataException.voidclose()Indicates that this endpoint has finished reading or writing.intReturns the number of contacts requested per page (defaults to 50).Returns the pending error recorded by this reader (such as a failed batch request) or null; the next read throws it.Returns the comma-separated person fields requested for each contact.Returns the resource name whose connections are read (defaults to"people/me").voidopen()Makes this endpoint ready for reading or writing.protected RecordreadImpl()Overridden by subclasses to read the next record from thisDataReader.setBatchSize(int batchSize) Sets the number of contacts requested per page, from 1 to 100 (defaults to 50).setPersonFields(String personFields) Sets the comma-separated person fields requested for each contact.setResource(String resource) Sets the resource name whose connections are read (defaults to"people/me").Methods inherited from class com.northconcepts.datapipeline.google.GoogleApiReader
getApplicationName, setApplicationName, setJsonFactory, toDate, toExceptionMethods 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
-
GoogleContactsReader
public GoogleContactsReader(Credential credential, HttpTransport httpTransport) Creates a reader that uses the caller's transport, which is not shut down on close.
-
-
Method Details
-
getPersonFields
Returns the comma-separated person fields requested for each contact. -
setPersonFields
Sets the comma-separated person fields requested for each contact. -
getResource
Returns the resource name whose connections are read (defaults to"people/me"). -
setResource
Sets the resource name whose connections are read (defaults to"people/me"). -
getBatchSize
public int getBatchSize()Returns the number of contacts requested per page (defaults to 50). -
setBatchSize
Sets the number of contacts requested per page, from 1 to 100 (defaults to 50). -
getException
Returns the pending error recorded by this reader (such as a failed batch request) or null; the next read throws it. -
open
Description copied from class:DataEndpointMakes this endpoint ready for reading or writing.- Overrides:
openin classIntegrationReader- Throws:
DataException
-
close
public void close()Description copied from class:DataEndpointIndicates that this endpoint has finished reading or writing.- Overrides:
closein classGoogleApiReader
-
readImpl
Description copied from class:DataReaderOverridden by subclasses to read the next record from thisDataReader. The default implementation ofDataReader.read()now insures that this method will not be called again after it returns anull.If no record is available,
nullwill be returned.Contract for subclasses (see also
docs/authoring/DataReader.md):- Return
nullexactly once to signal end-of-stream. - Do not call this method directly —
DataReader.read()is the template method that wraps exceptions, increments the record count, and tracks lineage. - Do not call
DataEndpoint.incrementRecordCount()here;DataReader.read()already does. - Throw raw exceptions;
DataReader.read()wraps them viaexception(throwable).
- Specified by:
readImplin classDataReader- Throws:
Throwable
- Return
-
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 classGoogleApiReader
-