Package com.esri.arcgisruntime.tasks.geodatabase

Class SyncGeodatabaseJob

java.lang.Object

com.esri.arcgisruntime.concurrent.Job

com.esri.arcgisruntime.tasks.geodatabase.SyncGeodatabaseJob

All Implemented Interfaces:

JsonSerializable, RemoteResource

public final class SyncGeodatabaseJob
extends Job

A Job that synchronizes changes between a local geodatabase and an ArcGIS feature service.

Synchronization can include sending feature edits made locally and retrieving feature edits made on the server, this can be controlled by setting the SyncGeodatabaseParameters.SyncDirection. Only changes are sent/received during the synchronization process to ensure only the minimum required data is transferred.

A SyncGeodatabaseJob instance is returned by GeodatabaseSyncTask.syncGeodatabase(SyncGeodatabaseParameters, Geodatabase). The Job is returned in a Job.Status.NOT_STARTED state and Job.start() must be called to start the associated operation.

See the Job class for full information on how to work with jobs.

Since:

100.0.0

See Also:

Job

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.arcgisruntime.concurrent.Job

Job.Message, Job.MessageSeverity, Job.MessageSource, Job.Status

Field Summary

Fields inherited from class com.esri.arcgisruntime.concurrent.Job

mCredential, mRequestConfiguration

Method Summary

Modifier and Type	Method	Description
GeodatabaseDeltaInfo	getGeodatabaseDeltaInfo()	Gets information on geodatabase upload and download delta files.
List<SyncLayerResult>	getResult()	For a successfully completed job, the result returns a list of SyncLayerResult.

Methods inherited from class com.esri.arcgisruntime.concurrent.Job

addJobChangedListener, addJobDoneListener, addJobMessageAddedListener, addProgressChangedListener, addStatusChangedListener, cancel, cancelAsync, fromJson, getCredential, getError, getMessages, getProgress, getRequestConfiguration, getServerJobId, getStatus, getUnknownJson, getUnsupportedJson, getUri, pause, removeJobChangedListener, removeJobDoneListener, removeJobMessageAddedListener, removeProgressChangedListener, removeStatusChangedListener, setCredential, setRequestConfiguration, setUri, start, toJson

Methods inherited from class java.lang.Object

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

Method Detail

getGeodatabaseDeltaInfo

public GeodatabaseDeltaInfo getGeodatabaseDeltaInfo()

Gets information on geodatabase upload and download delta files.

When SyncGeodatabaseParameters.isKeepGeodatabaseDeltas() is set to true, this property provides information about the synced geodatabase along with the paths to its uploaded and downloaded deltas.

Delta geodatabases allow you to troubleshoot sync problems - for example by inspecting the changes they contain or sending the file to the system administrator for the feature service.

This property will be set even if the job fails. If SyncGeodatabaseParameters.isKeepGeodatabaseDeltas() is false, this property will be null.

Returns:

an unmodifiable list containing information on geodatabase upload and download delta files, or null if none

Since:

100.10.0

getResult

public List<SyncLayerResult> getResult()

For a successfully completed job, the result returns a list of SyncLayerResult. Typically, when all features are synced successfully, this is an empty list.

If individual edits failed, then the result list provides these errors grouped by each table, using SyncLayerResult instances. These in turn contain each edit error. Only errors are reported; the feature edit results do not contain information about successful adds, deletes, or updates.

Specified by:

getResult in class Job

Returns:

an unmodifiable list of SyncLayerResult objects once the job has completed successfully, otherwise an empty list

Since:

100.0.0

See Also:

SyncLayerResult