ESAuditMigrationWork (Nuxeo 2021.70.4 API Documentation)

java.lang.Object
- org.nuxeo.ecm.core.work.AbstractWork
- - org.nuxeo.elasticsearch.audit.ESAuditMigrationWork

All Implemented Interfaces:

Serializable, Work
```
public class ESAuditMigrationWork
extends AbstractWork
```
Work for the SQL to Elasticsearch audit migration.

Since:

7.10

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work
  Work.Progress, Work.State

Field Summary

Fields
Modifier and Type Field Description

protected int batchSize
- Fields inherited from class org.nuxeo.ecm.core.work.AbstractWork
  callerThread, completionTime, docId, docIds, FAILURE_EXCEPTION, FAILURE_MSG, GLOBAL_DLQ_COUNT_REGISTRY_NAME, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending, traceContext, WORK_FAILED_EVENT, WORK_INSTANCE

Constructor Summary

Constructors
Constructor Description

ESAuditMigrationWork(String id, int batchSize)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getTitle()`	Gets a human-readable name for this work instance.
`void`	`work()`	This method should implement the actual work done by the `Work` instance.

Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork
appendWorkToDeadLetterQueue, buildWorkFailureEventProps, cleanUp, closeSession, commitOrRollbackTransaction, equals, getCategory, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getPartitionKey, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getSpanFromContext, getStartTime, getStatus, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString, workFailed

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.work.api.Work
isCoalescing, isGroupJoin, isIdempotent, onGroupJoinCompletion

- Field Detail
  - batchSize
```
protected int batchSize
```
- Constructor Detail
  - ESAuditMigrationWork
```
public ESAuditMigrationWork(String id,
                            int batchSize)
```
- Method Detail
  - getTitle
```
public String getTitle()
```
    Description copied from interface: Work
    
    Gets a human-readable name for this work instance.
    
    Returns:
    
    a human-readable name
  - work
```
public void work()
```
    Description copied from interface: Work
    
    This method should implement the actual work done by the Work instance.
    It should periodically update its progress through Work.setProgress(org.nuxeo.ecm.core.work.api.Work.Progress).
    To allow for suspension by the WorkManager, it should periodically call Work.isSuspending(), and if true call Work.suspended() return early with saved state data.
    Clean up can by implemented by Work.cleanUp(boolean, Exception).
    
    Specified by:
    
    work in interface Work
    
    Specified by:
    
    work in class AbstractWork
    
    See Also:
    
    Work.isSuspending(), Work.suspended(), Work.cleanUp(boolean, java.lang.Exception)