@Path(value="tasks") public interface TaskService extends ExecutableService
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 |
---|---|
javax.ws.rs.core.Response |
create(@NotNull TaskType type,
@NotNull SchedTaskTO taskTO)
Creates a new task.
|
void |
delete(@NotNull TaskType type,
@NotNull String key)
Deletes the task matching the provided key.
|
javax.ws.rs.core.Response |
purgePropagations(Date since,
List<ExecStatus> statuses,
List<String> resources)
Deletes all the propagation tasks whose latest execution is matching the given conditions.
|
<T extends TaskTO> |
read(@NotNull TaskType type,
@NotNull String key,
boolean details)
Returns the task matching the given key.
|
<T extends TaskTO> |
search(TaskQuery query)
Returns a paged list of existing tasks matching the given query.
|
void |
update(@NotNull TaskType type,
@NotNull SchedTaskTO taskTO)
Updates the task matching the provided key.
|
actionJob, deleteExecution, deleteExecutions, execute, getJob, listExecutions, listJobs, listRecentExecutions
@GET @Path(value="{type}/{key}") @Produces(value={"application/json","application/yaml","application/xml"}) <T extends TaskTO> T read(@NotNull @PathParam(value="type") @NotNull TaskType type, @NotNull @PathParam(value="key") @NotNull String key, @QueryParam(value="details") @DefaultValue(value="true") boolean details)
T
- type of taskTOtype
- task typekey
- key of task to be readdetails
- whether include executions or not, defaults to true@GET @Path(value="{type}") @Produces(value={"application/json","application/yaml","application/xml"}) <T extends TaskTO> PagedResult<T> search(@BeanParam TaskQuery query)
T
- type of taskTOquery
- query conditions@POST @Path(value="{type}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response create(@NotNull @PathParam(value="type") @NotNull TaskType type, @NotNull @NotNull SchedTaskTO taskTO)
type
- task typetaskTO
- task to be created@PUT @Path(value="{type}/{key}") @Consumes(value={"application/json","application/yaml","application/xml"}) @Produces(value={"application/json","application/yaml","application/xml"}) void update(@NotNull @PathParam(value="type") @NotNull TaskType type, @NotNull @NotNull SchedTaskTO taskTO)
type
- task typetaskTO
- updated task to be stored@DELETE @Path(value="{type}/{key}") @Produces(value={"application/json","application/yaml","application/xml"}) void delete(@NotNull @PathParam(value="type") @NotNull TaskType type, @NotNull @PathParam(value="key") @NotNull String key)
type
- task typekey
- key of task to be deleted@DELETE @Path(value="PROPAGATION/purge") @Produces(value={"application/json","application/yaml","application/xml"}) javax.ws.rs.core.Response purgePropagations(@QueryParam(value="since") Date since, @QueryParam(value="statuses") List<ExecStatus> statuses, @QueryParam(value="resources") List<String> resources)
since
- match all executions started afterwardsstatuses
- execution status(es) to matchresources
- external resource(s) to matchCopyright © 2010–2023 The Apache Software Foundation. All rights reserved.