You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2020/07/19 14:23:33 UTC

[shardingsphere-elasticjob] branch master updated: translate user manual, java-api for configuration. (#1173)

This is an automated email from the ASF dual-hosted git repository.

zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere-elasticjob.git


The following commit(s) were added to refs/heads/master by this push:
     new 9983de6  translate user manual, java-api for configuration. (#1173)
9983de6 is described below

commit 9983de6b9da739ed68b00e57c4c0c5cf42bc41d6
Author: Zonglei Dong <do...@apache.org>
AuthorDate: Sun Jul 19 22:23:26 2020 +0800

    translate user manual, java-api for configuration. (#1173)
---
 .../elasticjob-lite/configuration/java-api.en.md   | 62 +++++++++++++++++++++-
 1 file changed, 61 insertions(+), 1 deletion(-)

diff --git a/docs/content/user-manual/elasticjob-lite/configuration/java-api.en.md b/docs/content/user-manual/elasticjob-lite/configuration/java-api.en.md
index a154315..bf1fddf 100644
--- a/docs/content/user-manual/elasticjob-lite/configuration/java-api.en.md
+++ b/docs/content/user-manual/elasticjob-lite/configuration/java-api.en.md
@@ -4,4 +4,64 @@ weight = 1
 chapter = true
 +++
 
-TODO
\ No newline at end of file
+## Registry Center Configuration
+
+The component which is used to register and coordinate the distributed behavior of jobs, currently only supports `ZooKeeper`.
+
+Class name: `org.apache.shardingsphere.elasticjob.reg.zookeeper.ZookeeperConfiguration`
+
+Configuration: 
+
+| Name                          | Constructor injection |
+| ----------------------------- |:--------------------- |
+| serverLists                   | Yes                   |
+| namespace                     | Yes                   |
+| baseSleepTimeMilliseconds     | No                    |
+| maxSleepTimeMilliseconds      | No                    |
+| maxRetries                    | No                    |
+| sessionTimeoutMilliseconds    | No                    |
+| connectionTimeoutMilliseconds | No                    |
+| digest                        | No                    |
+
+## Job Configuration
+
+Class name: `org.apache.shardingsphere.elasticjob.api.JobConfiguration`
+
+Configuration:
+
+| Name                          | Constructor injection |
+| ----------------------------- |:--------------------- |
+| jobName                       | Yes                   |
+| shardingTotalCount            | Yes                   |
+| cron                          | No                    |
+| shardingItemParameters        | No                    |
+| jobParameter                  | No                    |
+| monitorExecution              | No                    |
+| failover                      | No                    |
+| misfire                       | No                    |
+| maxTimeDiffSeconds            | No                    |
+| reconcileIntervalMinutes      | No                    |
+| jobShardingStrategyType       | No                    |
+| jobExecutorServiceHandlerType | No                    |
+| jobErrorHandlerType           | No                    |
+| description                   | No                    |
+| props                         | No                    |
+| disabled                      | No                    |
+| overwrite                     | No                    |
+
+## Job Listener Configuration
+
+### Common Listener Configuration
+
+Interface name: `org.apache.shardingsphere.elasticjob.api.listener.ElasticJobListener`
+
+Configuration: no
+
+### Distributed Listener Configuration
+
+Class name: `org.apache.shardingsphere.elasticjob.lite.api.listener.AbstractDistributeOnceElasticJobListener`
+
+| Name                           | Constructor injection |
+| ------------------------------ |:--------------------- |
+| started-timeout-milliseconds   | Yes                   |
+| completed-timeout-milliseconds | Yes                   |