@@ -22,7 +22,7 @@ Class name: `org.apache.shardingsphere.elasticjob.lifecycle.api.JobConfiguration
22
22
23
23
### Get job configuration
24
24
25
- Method signature:YamlJobConfiguration getJobConfiguration(String jobName)
25
+ Method signature:` JobConfigurationPOJO getJobConfiguration(String jobName)`
26
26
27
27
* ** Parameters:**
28
28
* jobName — Job name
@@ -31,14 +31,14 @@ Method signature:YamlJobConfiguration getJobConfiguration(String jobName)
31
31
32
32
### Update job configuration
33
33
34
- Method signature:void updateJobConfiguration(YamlJobConfiguration yamlJobConfiguration)
34
+ Method signature:` void updateJobConfiguration(JobConfigurationPOJO jobConfig) `
35
35
36
36
* ** Parameters:**
37
- * jobConfiguration — Job configuration object
37
+ * jobConfig — Job configuration object
38
38
39
39
### Remove job configuration
40
40
41
- Method signature:void removeJobConfiguration(String jobName)
41
+ Method signature:` void removeJobConfiguration(String jobName) `
42
42
43
43
* ** Parameters:**
44
44
* jobName — Job name
@@ -51,7 +51,7 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.JobOperateAPI`
51
51
52
52
The job will only trigger execution if it does not conflict with the currently running job, and this flag will be automatically cleared after it is started.
53
53
54
- Method signature:void trigger(Optional< String > jobName)
54
+ Method signature:` void trigger(String jobName) `
55
55
56
56
* ** Parameters:**
57
57
* jobName — Job name
@@ -60,39 +60,39 @@ Method signature:void trigger(Optional<String> jobName)
60
60
61
61
Disabling a job will cause other distributed jobs to trigger resharding.
62
62
63
- Method signature:void disable(Optional< String > jobName, Optional< String > serverIp)
63
+ Method signature:` void disable(String jobName, String serverIp) `
64
64
65
65
* ** Parameters:**
66
66
* jobName — Job name
67
67
* serverIp — job server IP address
68
68
69
69
### Enable job
70
70
71
- Method signature:void enable(Optional< String > jobName, Optional< String > serverIp)
71
+ Method signature:` void enable(String jobName, String serverIp) `
72
72
73
73
* ** Parameters:**
74
74
* jobName — Job name
75
75
* serverIp — job server IP address
76
76
77
77
### Shutdown scheduling job
78
78
79
- Method signature:void shutdown(Optional< String > jobName, Optional< String > serverIp)
79
+ Method signature:` void shutdown(String jobName, String serverIp) `
80
80
81
81
* ** Parameters:**
82
82
* jobName — Job name
83
83
* serverIp — IP address of the job server
84
84
85
85
### Remove job
86
86
87
- Method signature:void remove(Optional< String > jobName, Optional< String > serverIp)
87
+ Method signature:` void remove(String jobName, String serverIp) `
88
88
89
89
* ** Parameters:**
90
90
* jobName — Job name
91
91
* serverIp — IP address of the job server
92
92
93
93
### Dump job
94
94
95
- Method signature:String dump(String jobName, String instanceIp, int dumpPort)
95
+ Method signature:` String dump(String jobName, String instanceIp, int dumpPort) throws IOException `
96
96
97
97
* ** Parameters:**
98
98
* jobName — Job name
@@ -105,15 +105,15 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.ShardingOperate
105
105
106
106
### Disable job sharding
107
107
108
- Method signature:void disable(String jobName, String item)
108
+ Method signature:` void disable(String jobName, String item) `
109
109
110
110
* ** Parameters:**
111
111
* jobName — Job name
112
112
* item — Job sharding item
113
113
114
114
### Enable job sharding
115
115
116
- Method signature:void enable(String jobName, String item)
116
+ Method signature:` void enable(String jobName, String item) `
117
117
118
118
* ** Parameters:**
119
119
* jobName — Job name
@@ -125,13 +125,13 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.JobStatisticsAP
125
125
126
126
### Get the total count of jobs
127
127
128
- Method signature:int getJobsTotalCount()
128
+ Method signature:` int getJobsTotalCount() `
129
129
130
130
* ** Returns:** the total count of jobs
131
131
132
132
### Get brief job information
133
133
134
- Method signature:JobBriefInfo getJobBriefInfo(String jobName)
134
+ Method signature:` JobBriefInfo getJobBriefInfo(String jobName) `
135
135
136
136
* ** Parameters:**
137
137
* jobName — Job name
@@ -140,13 +140,13 @@ Method signature:JobBriefInfo getJobBriefInfo(String jobName)
140
140
141
141
### Get brief information about all jobs.
142
142
143
- Method signature:Collection<JobBriefInfo > getAllJobsBriefInfo()
143
+ Method signature:` Collection<JobBriefInfo> getAllJobsBriefInfo() `
144
144
145
145
* ** Returns:** Brief collection of all job information
146
146
147
147
### Get brief information of all jobs under this IP
148
148
149
- Method signature:Collection<JobBriefInfo > getJobsBriefInfo(String ip)
149
+ Method signature:` Collection<JobBriefInfo> getJobsBriefInfo(String ip) `
150
150
151
151
* ** Parameters:**
152
152
* ip — server IP
@@ -159,13 +159,13 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.ServerStatistic
159
159
160
160
### Total count of job servers
161
161
162
- Method signature:int getServersTotalCount()
162
+ Method signature:` int getServersTotalCount() `
163
163
164
164
* ** Returns:** Get the total count of job servers
165
165
166
166
### Get brief information about all job servers
167
167
168
- Method signature:Collection<ServerBriefInfo > getAllServersBriefInfo()
168
+ Method signature:` Collection<ServerBriefInfo> getAllServersBriefInfo() `
169
169
170
170
* ** Returns:** Brief collection of job information
171
171
@@ -175,7 +175,7 @@ Class name:`org.apache.shardingsphere.elasticjob.lifecycle.api.ShardingStatist
175
175
176
176
### Get job sharding information collection
177
177
178
- Method signature:Collection<ShardingInfo > getShardingInfo(String jobName)
178
+ Method signature:` Collection<ShardingInfo> getShardingInfo(String jobName) `
179
179
180
180
* ** Parameters:**
181
181
* jobName — Job name
0 commit comments