JobConfiguration.Builder (elasticjob-api 3.0.1 API)

java.lang.Object
- org.apache.shardingsphere.elasticjob.api.JobConfiguration.Builder

Enclosing class:: JobConfiguration

public static class JobConfiguration.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobConfiguration.Builder`	`addExtraConfigurations(JobExtraConfiguration extraConfig)` Add extra configurations.
`JobConfiguration`	`build()` Build ElasticJob configuration.
`JobConfiguration.Builder`	`cron(String cron)` Cron expression.
`JobConfiguration.Builder`	`description(String description)` Set job description.
`JobConfiguration.Builder`	`disabled(boolean disabled)` Set whether disable job when start.
`JobConfiguration.Builder`	`failover(boolean failover)` Set enable failover.
`JobConfiguration.Builder`	`jobErrorHandlerType(String jobErrorHandlerType)` Set job error handler type.
`JobConfiguration.Builder`	`jobExecutorServiceHandlerType(String jobExecutorServiceHandlerType)` Set job executor service handler type.
`JobConfiguration.Builder`	`jobListenerTypes(String... jobListenerTypes)` Set job listener types.
`JobConfiguration.Builder`	`jobParameter(String jobParameter)` Set job parameter.
`JobConfiguration.Builder`	`jobShardingStrategyType(String jobShardingStrategyType)` Set job sharding strategy type.
`JobConfiguration.Builder`	`label(String label)` Set label.
`JobConfiguration.Builder`	`maxTimeDiffSeconds(int maxTimeDiffSeconds)` Set max tolerate time different seconds between job server and registry center.
`JobConfiguration.Builder`	`misfire(boolean misfire)` Set enable misfire.
`JobConfiguration.Builder`	`monitorExecution(boolean monitorExecution)` Set enable or disable monitor execution.
`JobConfiguration.Builder`	`overwrite(boolean overwrite)` Set whether overwrite local configuration to registry center when job startup.
`JobConfiguration.Builder`	`reconcileIntervalMinutes(int reconcileIntervalMinutes)` Set reconcile interval minutes for job sharding status.
`JobConfiguration.Builder`	`setProperty(String key, String value)` Set property.
`JobConfiguration.Builder`	`shardingItemParameters(String shardingItemParameters)` Set mapper of sharding items and sharding parameters.
`JobConfiguration.Builder`	`staticSharding(boolean staticSharding)` Set static sharding.
`JobConfiguration.Builder`	`timeZone(String timeZone)` time zone.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - cron
```
public JobConfiguration.Builder cron(String cron)
```
    Cron expression.
    
    Parameters:
    
    cron - cron expression
    
    Returns:
    
    job configuration builder
  - timeZone
```
public JobConfiguration.Builder timeZone(String timeZone)
```
    time zone.
    
    Parameters:
    
    timeZone - the time zone
    
    Returns:
    
    job configuration builder
  - shardingItemParameters
```
public JobConfiguration.Builder shardingItemParameters(String shardingItemParameters)
```
    Set mapper of sharding items and sharding parameters.
    sharding item and sharding parameter split by =, multiple sharding items and sharding parameters split by comma, just like map. Sharding item start from zero, cannot equal to great than sharding total count. For example: 0=a,1=b,2=c
    
    Parameters:
    
    shardingItemParameters - mapper of sharding items and sharding parameters
    
    Returns:
    
    job configuration builder
  - jobParameter
```
public JobConfiguration.Builder jobParameter(String jobParameter)
```
    Set job parameter.
    
    Parameters:
    
    jobParameter - job parameter
    
    Returns:
    
    job configuration builder
  - monitorExecution
```
public JobConfiguration.Builder monitorExecution(boolean monitorExecution)
```
    Set enable or disable monitor execution.
    For short interval job, it is better to disable monitor execution to improve performance. It can't guarantee repeated data fetch and can't failover if disable monitor execution, please keep idempotence in job. For long interval job, it is better to enable monitor execution to guarantee fetch data exactly once.
    
    Parameters:
    
    monitorExecution - monitor job execution status
    
    Returns:
    
    ElasticJob configuration builder
  - failover
```
public JobConfiguration.Builder failover(boolean failover)
```
    Set enable failover.
    Only for `monitorExecution` enabled.
    
    Parameters:
    
    failover - enable or disable failover
    
    Returns:
    
    job configuration builder
  - misfire
```
public JobConfiguration.Builder misfire(boolean misfire)
```
    Set enable misfire.
    
    Parameters:
    
    misfire - enable or disable misfire
    
    Returns:
    
    job configuration builder
  - maxTimeDiffSeconds
```
public JobConfiguration.Builder maxTimeDiffSeconds(int maxTimeDiffSeconds)
```
    Set max tolerate time different seconds between job server and registry center.
    ElasticJob will throw exception if exceed max tolerate time different seconds. -1 means do not check.
    
    Parameters:
    
    maxTimeDiffSeconds - max tolerate time different seconds between job server and registry center
    
    Returns:
    
    ElasticJob configuration builder
  - reconcileIntervalMinutes
```
public JobConfiguration.Builder reconcileIntervalMinutes(int reconcileIntervalMinutes)
```
    Set reconcile interval minutes for job sharding status.
    Monitor the status of the job server at regular intervals, and resharding if incorrect.
    
    Parameters:
    
    reconcileIntervalMinutes - reconcile interval minutes for job sharding status
    
    Returns:
    
    ElasticJob configuration builder
  - jobShardingStrategyType
```
public JobConfiguration.Builder jobShardingStrategyType(String jobShardingStrategyType)
```
    Set job sharding strategy type.
    Default for AverageAllocationJobShardingStrategy.
    
    Parameters:
    
    jobShardingStrategyType - job sharding strategy type
    
    Returns:
    
    ElasticJob configuration builder
  - jobExecutorServiceHandlerType
```
public JobConfiguration.Builder jobExecutorServiceHandlerType(String jobExecutorServiceHandlerType)
```
    Set job executor service handler type.
    
    Parameters:
    
    jobExecutorServiceHandlerType - job executor service handler type
    
    Returns:
    
    job configuration builder
  - jobErrorHandlerType
```
public JobConfiguration.Builder jobErrorHandlerType(String jobErrorHandlerType)
```
    Set job error handler type.
    
    Parameters:
    
    jobErrorHandlerType - job error handler type
    
    Returns:
    
    job configuration builder
  - jobListenerTypes
```
public JobConfiguration.Builder jobListenerTypes(String... jobListenerTypes)
```
    Set job listener types.
    
    Parameters:
    
    jobListenerTypes - job listener types
    
    Returns:
    
    ElasticJob configuration builder
  - addExtraConfigurations
```
public JobConfiguration.Builder addExtraConfigurations(JobExtraConfiguration extraConfig)
```
    Add extra configurations.
    
    Parameters:
    
    extraConfig - job extra configuration
    
    Returns:
    
    job configuration builder
  - description
```
public JobConfiguration.Builder description(String description)
```
    Set job description.
    
    Parameters:
    
    description - job description
    
    Returns:
    
    job configuration builder
  - setProperty
```
public JobConfiguration.Builder setProperty(String key,
                                            String value)
```
    Set property.
    
    Parameters:
    
    key - property key
    
    value - property value
    
    Returns:
    
    job configuration builder
  - disabled
```
public JobConfiguration.Builder disabled(boolean disabled)
```
    Set whether disable job when start.
    Using in job deploy, start job together after deploy.
    
    Parameters:
    
    disabled - whether disable job when start
    
    Returns:
    
    ElasticJob configuration builder
  - overwrite
```
public JobConfiguration.Builder overwrite(boolean overwrite)
```
    Set whether overwrite local configuration to registry center when job startup.
    If overwrite enabled, every startup will use local configuration.
    
    Parameters:
    
    overwrite - whether overwrite local configuration to registry center when job startup
    
    Returns:
    
    ElasticJob configuration builder
  - label
```
public JobConfiguration.Builder label(String label)
```
    Set label.
    
    Parameters:
    
    label - label
    
    Returns:
    
    ElasticJob configuration builder
  - staticSharding
```
public JobConfiguration.Builder staticSharding(boolean staticSharding)
```
    Set static sharding.
    
    Parameters:
    
    staticSharding - static sharding
    
    Returns:
    
    ElasticJob configuration builder
  - build
```
public final JobConfiguration build()
```
    Build ElasticJob configuration.
    
    Returns:
    
    ElasticJob configuration

Class JobConfiguration.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

cron

timeZone

shardingItemParameters

jobParameter

monitorExecution

failover

misfire

maxTimeDiffSeconds

reconcileIntervalMinutes

jobShardingStrategyType

jobExecutorServiceHandlerType

jobErrorHandlerType

jobListenerTypes

addExtraConfigurations

description

setProperty

disabled

overwrite

label

staticSharding

build