public interface PartitionPlan
Modifier and Type | Method and Description |
---|---|
java.util.Properties[] |
getPartitionProperties()
Gets array of Partition Properties objects for Partitions.
|
int |
getPartitions()
Gets count of Partitions.
|
boolean |
getPartitionsOverride()
Return current value of partition override setting.
|
int |
getThreads()
Gets maximum number of threads requested to use to run
partitions for this step.
|
void |
setPartitionProperties(java.util.Properties[] props)
Sets array of substitution Properties objects for the set of Partitions.
|
void |
setPartitions(int count)
Set number of partitions.
|
void |
setPartitionsOverride(boolean override)
Specify whether or not to override the partition
count from the previous job execution.
|
void |
setThreads(int count)
Set maximum number of threads requested to use to run
partitions for this step.
|
void setPartitions(int count)
count
- specifies the partition countvoid setPartitionsOverride(boolean override)
When false
is specified, the
partition count from the previous job execution is used
and any new value set for partition count in the current run
is ignored. In addition, partition results from the previous
job execution are remembered, and only incomplete partitions
are reprocessed.
When true
is specified, the partition count from the current run
is used and all results from past partitions are discarded. Any
resource cleanup or back out of work done in the previous run is the
responsibility of the application. The PartitionReducer artifact's
rollbackPartitionedStep method is invoked during restart before any
partitions begin processing to provide a cleanup hook.
override
- See method descriptionboolean getPartitionsOverride()
setPartitionsOverride(boolean)
void setThreads(int count)
count
- specifies the requested thread countvoid setPartitionProperties(java.util.Properties[] props)
props
- specifies the Properties object arraygetPartitionProperties()
int getPartitions()
int getThreads()
java.util.Properties[] getPartitionProperties()
These can be used in Job XML substitution using substitution expressions with the syntax: #{partitionPlan['propertyName']}
Each element of the Properties array returned can be used to resolving substitutions for a single partition. In the typical use case, each Properties element will have a similar set of property names, with a substitution potentially resolving to the corresponding value for each partition.