Skip to content

Commit

Permalink
Update java docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
haocao committed Apr 6, 2017
1 parent 7afa739 commit cb34fc2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 9 deletions.
24 changes: 23 additions & 1 deletion elastic-job-doc/content/post/user_guide/lite/operation_manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ weight=15

### 2. 操作类API

#### `JobOperateAPI` 操作作业的API
#### 2.1 `JobOperateAPI` 操作作业的API

##### `void trigger(Optional<String> jobName, Optional<String> serverIp)` 作业立刻执行.作业在不与上次运行中作业冲突的情况下才会启动, 并在启动后自动清理此标记.

Expand Down Expand Up @@ -62,10 +62,28 @@ weight=15
* `jobName` — 作业名称
* `serverIp` — 作业服务器IP地址

#### 2.2 `ShardingOperateAPI` 操作分片的API

##### `void disable(String jobName, String item)` 禁用作业分片.

* **Parameters:**
* `jobName` — 作业名称
* `item` — 作业分片项

##### `void enable(String jobName, String item)` 启用作业分片.

* **Parameters:**
* `jobName` — 作业名称
* `item` — 作业分片项

### 3. 统计类API

#### 3.1 `JobStatisticsAPI` 作业状态展示的API

##### `int getJobsTotalCount()` 获取作业总数.

* **Returns:** 作业总数

##### `JobBriefInfo getJobBriefInfo(String jobName)` 获取作业简明信息.

* **Parameters:** `jobName` — 作业名称
Expand All @@ -84,6 +102,10 @@ weight=15

#### 3.2 `ServerStatisticsAPI` 作业服务器状态展示的API

##### `int getServersTotalCount()` 获取作业服务器总数.

* **Returns:** 作业服务器总数

##### `Collection<ServerBriefInfo> getAllServersBriefInfo()` 获取所有作业服务器简明信息.

* **Returns:** 作业服务器简明信息集合
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,18 @@
public interface ShardingOperateAPI {

/**
* 分片禁用.
* 禁用作业分片.
*
* <p>会重新分片.</p>
*
* @param jobName 作业名称
* @param sharding 分片项
* @param item 分片项
*/
void disable(String jobName, String sharding);
void disable(String jobName, String item);

/**
* 分片启用.
* 启用作业分片.
*
* @param jobName 作业名称
* @param sharding 分片项
* @param item 分片项
*/
void enable(String jobName, String sharding);
void enable(String jobName, String item);
}

0 comments on commit cb34fc2

Please sign in to comment.