Class JobEnvironmentRestResource

java.lang.Object

org.tasktide.api.resources.services.rest.JobEnvironmentRestResource

@Path("/services/job-environment")
@RequestScoped
public class JobEnvironmentRestResource
extends Object

REST resource for interacting with JobEnvironmentService

Constructor Summary

Constructors

Constructor	Description
JobEnvironmentRestResource()	Construct with JobEnvironment TaskTideService

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createJobEnvironment(JobEnvironment jobEnvironment, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)	Endpoint to create provided JobEnvironment, returning whether the resource was created to the client
jakarta.ws.rs.core.Response	createJobEnvironments(List<JobEnvironment> jobEnvironments, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)	Endpoint to import provided JobEnvironment collection, returning whether the resource was created to the client
jakarta.ws.rs.core.Response	dropJobEnvironment(String id, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)	Endpoint for dropping JobEnvironment by Id
jakarta.ws.rs.core.Response	readJobEnvironment(String id, String field, String value, String grouping, String groupingVal, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)	Endpoint for fetching JobEnvironment by Id, field having value, or field having value for a group having a value
jakarta.ws.rs.core.Response	updateJobEnvironment(JobEnvironment jobEnvironment, jakarta.ws.rs.core.HttpHeaders reqHeader, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.SecurityContext securityContext)	Endpoint for updating JobEnvironment providing new resource

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JobEnvironmentRestResource

public JobEnvironmentRestResource()

Construct with JobEnvironment TaskTideService

Method Details

createJobEnvironment

@POST
@Path("/add")
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response createJobEnvironment(JobEnvironment jobEnvironment,
 @Context
 jakarta.ws.rs.core.HttpHeaders reqHeader,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

Endpoint to create provided JobEnvironment, returning whether the resource was created to the client

Parameters:

jobEnvironment -

reqHeader -

uriInfo -

securityContext -

Returns:

Response

createJobEnvironments

@POST
@Path("/import")
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response createJobEnvironments(List<JobEnvironment> jobEnvironments,
 @Context
 jakarta.ws.rs.core.HttpHeaders reqHeader,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

Endpoint to import provided JobEnvironment collection, returning whether the resource was created to the client

Parameters:

jobEnvironments -

reqHeader -

uriInfo -

securityContext -

Returns:

Response

readJobEnvironment

@GET
@Path("/get")
@Produces("application/json")
public jakarta.ws.rs.core.Response readJobEnvironment(@QueryParam("id")
 String id,
 @QueryParam("field")
 String field,
 @QueryParam("value")
 String value,
 @QueryParam("grouping")
 String grouping,
 @QueryParam("groupingValue")
 String groupingVal,
 @Context
 jakarta.ws.rs.core.HttpHeaders reqHeader,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

Endpoint for fetching JobEnvironment by Id, field having value, or field having value for a group having a value

Parameters:

id -

field -

value -

grouping -

groupingVal -

reqHeader -

uriInfo -

securityContext -

Returns:

Response

dropJobEnvironment

@DELETE
@Path("/drop/{id}")
@Produces("application/json")
public jakarta.ws.rs.core.Response dropJobEnvironment(@PathParam("id")
 String id,
 @Context
 jakarta.ws.rs.core.HttpHeaders reqHeader,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

Endpoint for dropping JobEnvironment by Id

Parameters:

id -

reqHeader -

uriInfo -

securityContext -

Returns:

Response

updateJobEnvironment

@PUT
@Path("/update")
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response updateJobEnvironment(JobEnvironment jobEnvironment,
 @Context
 jakarta.ws.rs.core.HttpHeaders reqHeader,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

Endpoint for updating JobEnvironment providing new resource

Parameters:

jobEnvironment -

reqHeader -

uriInfo -

securityContext -

Returns:

Response