Package org.nuxeo.ecm.core.bulk.message

Class BulkCommand

java.lang.Object
org.nuxeo.ecm.core.bulk.message.BulkCommand
All Implemented Interfaces:
Serializable
public class BulkCommand extends Object implements Serializable
A message representing a bulk command
Since:
10.2
See Also:

  • Field Details

    • id

      protected String id

    • action

      protected String action

    • query

      protected String query

    • queryLimit

      @Nullable protected Long queryLimit

    • username

      protected String username

    • repository

      @Nullable protected String repository

    • bucketSize

      protected int bucketSize

    • batchSize

      protected int batchSize

    • batchTransactionTimeout

      @Nullable protected Long batchTransactionTimeout

    • scroller

      @Nullable protected String scroller

    • queryBuilderScroller

      protected boolean queryBuilderScroller
      Since:
      2025.18

    • genericScroller

      protected boolean genericScroller

    • externalScroller

      protected boolean externalScroller

    • sequentialScroll

      @Nullable protected Boolean sequentialScroll

    • sequentialProcessing

      @Nullable protected Boolean sequentialProcessing

    • exclusive

      @Nullable protected Boolean exclusive

    • params

      protected Map<String,Serializable> params

  • Constructor Details

    • BulkCommand

      protected BulkCommand()

    • BulkCommand

      public BulkCommand(BulkCommand.Builder builder)

  • Method Details

    • getUsername

      public String getUsername()

    • getRepository

      public String getRepository()

    • getQuery

      public String getQuery()

    • getAction

      public String getAction()

    • getScroller

      public String getScroller()

    • getSequentialScroll

      public Boolean getSequentialScroll()

    • getSequentialProcessing

      public Boolean getSequentialProcessing()

    • getExclusive

      public Boolean getExclusive()

    • useQueryBuilderScroller

      public boolean useQueryBuilderScroller()
      True if the command uses a queryBuilder scroller.
      Since:
      2025.18

    • useGenericScroller

      public boolean useGenericScroller()
      True if the command uses a generic scroller.
      Since:
      11.1

    • useExternalScroller

      public boolean useExternalScroller()
      True if the command uses an external scroller.
      Since:
      11.3

    • getParams

      public Map<String,Serializable> getParams()

    • getParam

      public <T> T getParam(String key)

    • getId

      public String getId()

    • getBucketSize

      public int getBucketSize()

    • getBatchSize

      public int getBatchSize()

    • getBatchTransactionTimeout

      public Duration getBatchTransactionTimeout()
      Precision is second.
      Since:
      11.5

    • getQueryLimit

      public Long getQueryLimit()
      When greater than 0, the limit applied to the query results
      Since:
      11.4

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setQueryLimit

      public void setQueryLimit(Long limit)

    • setBatchSize

      public void setBatchSize(int batchSize)

    • setBucketSize

      public void setBucketSize(int bucketSize)

    • setBatchTransactionTimeout

      public void setBatchTransactionTimeout(Duration timeout)
      Precision is second.
      Since:
      11.5

    • setRepository

      public void setRepository(String repository)

    • setScroller

      public void setScroller(String scrollerName)