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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class BulkCommand.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`action`
`protected int`	`batchSize`
`protected Long`	`batchTransactionTimeout`
`protected int`	`bucketSize`
`protected Boolean`	`exclusive`
`protected boolean`	`externalScroller`
`protected boolean`	`genericScroller`
`protected String`	`id`
`protected Map<String,Serializable>`	`params`
`protected String`	`query`
`protected Long`	`queryLimit`
`protected String`	`repository`
`protected String`	`scroller`
`protected Boolean`	`sequentialProcessing`
`protected Boolean`	`sequentialScroll`
`protected String`	`username`

Constructor Summary

Constructors
Modifier Constructor Description

protected BulkCommand()

BulkCommand(BulkCommand.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`String`	`getAction()`
`int`	`getBatchSize()`
`Duration`	`getBatchTransactionTimeout()`	Precision is second.
`int`	`getBucketSize()`
`Boolean`	`getExclusive()`
`String`	`getId()`
`<T> T`	`getParam(String key)`
`Map<String,Serializable>`	`getParams()`
`String`	`getQuery()`
`Long`	`getQueryLimit()`	When greater than 0, the limit applied to the query results
`String`	`getRepository()`
`String`	`getScroller()`
`Boolean`	`getSequentialProcessing()`
`Boolean`	`getSequentialScroll()`
`String`	`getUsername()`
`int`	`hashCode()`
`void`	`setBatchSize(int batchSize)`
`void`	`setBatchTransactionTimeout(Duration timeout)`	Precision is second.
`void`	`setBucketSize(int bucketSize)`
`void`	`setQueryLimit(Long limit)`
`void`	`setRepository(String repository)`
`void`	`setScroller(String scrollerName)`
`String`	`toString()`
`boolean`	`useExternalScroller()`	True if the command uses an external scroller.
`boolean`	`useGenericScroller()`	True if the command uses a generic scroller.

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

Field Detail

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
```

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 Detail

BulkCommand
```
protected BulkCommand()
```

BulkCommand

public BulkCommand(BulkCommand.Builder builder)

Method Detail

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()
```

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)

Modifier	Constructor	Description
`protected`	`BulkCommand()`
	`BulkCommand(BulkCommand.Builder builder)`

Class BulkCommand

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

action

query

queryLimit

username

repository

bucketSize

batchSize

batchTransactionTimeout

scroller

genericScroller

externalScroller

sequentialScroll

sequentialProcessing

exclusive

params

Constructor Detail

BulkCommand

BulkCommand

Method Detail

getUsername

getRepository

getQuery

getAction

getScroller

getSequentialScroll

getSequentialProcessing

getExclusive

useGenericScroller

useExternalScroller

getParams

getParam

getId

getBucketSize

getBatchSize

getBatchTransactionTimeout

getQueryLimit

hashCode

equals

toString

setQueryLimit

setBatchSize

setBucketSize

setBatchTransactionTimeout

setRepository

setScroller