public interface ExecutableService extends JAXRSService
CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER
Modifier and Type | Method and Description |
---|---|
void |
actionJob(@NotNull String key,
JobAction action)
Executes an action on an existing executable's job.
|
void |
deleteExecution(@NotNull String executionKey)
Deletes the executable execution matching the provided key.
|
javax.ws.rs.core.Response |
deleteExecutions(ExecQuery query)
Deletes the executions belonging matching the given query.
|
ExecTO |
execute(ExecSpecs query)
Executes the executable matching the given query.
|
JobTO |
getJob(String key)
Returns job (running or scheduled) for the executable matching the given key.
|
PagedResult<ExecTO> |
listExecutions(ExecQuery query)
Returns a paged list of executions matching the given query.
|
List<JobTO> |
listJobs()
List jobs (running and / or scheduled).
|
List<ExecTO> |
listRecentExecutions(@Min(value=1L) int max)
Returns the list of recently completed executions, ordered by end date descendent.
|
@GET @Path(value="{key}/executions") @Produces(value={"application/json","application/yaml","application/xml"}) PagedResult<ExecTO> listExecutions(@BeanParam ExecQuery query)
query
- query conditions@GET @Path(value="executions/recent") @Produces(value={"application/json","application/yaml","application/xml"}) List<ExecTO> listRecentExecutions(@Min(value=1L) @QueryParam(value="max") @DefaultValue(value="25") @Min(value=1L) int max)
max
- the maximum number of executions to return@DELETE @Path(value="executions/{executionKey}") @Produces(value={"application/json","application/yaml","application/xml"}) void deleteExecution(@NotNull @PathParam(value="executionKey") @NotNull String executionKey)
executionKey
- key of executable execution to be deleted@DELETE @Path(value="{key}/executions") @Produces(value="multipart/mixed") javax.ws.rs.core.Response deleteExecutions(@BeanParam ExecQuery query)
query
- query conditions@POST @Path(value="{key}/execute") @Produces(value={"application/json","application/yaml","application/xml"}) ExecTO execute(@BeanParam ExecSpecs query)
query
- query conditions@GET @Path(value="jobs/{key}") @Produces(value={"application/json","application/yaml","application/xml"}) JobTO getJob(@PathParam(value="key") String key)
key
- executable key@GET @Path(value="jobs") @Produces(value={"application/json","application/yaml","application/xml"}) List<JobTO> listJobs()
Copyright © 2010–2023 The Apache Software Foundation. All rights reserved.