Package org.openmetadata.service.resources.automations

Class WorkflowResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Workflow,WorkflowRepository>

org.openmetadata.service.resources.automations.WorkflowResource

@Path("/v1/automations/workflows")
@Produces("application/json")
@Consumes("application/json")
public class WorkflowResource
extends EntityResource<Workflow,WorkflowRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowResource.WorkflowList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_PATH

Fields inherited from class org.openmetadata.service.resources.EntityResource

allowedFields, authorizer, entityClass, entityType, fieldsToViewOperations, repository, VIEW_ALL_OPERATIONS, VIEW_BASIC_OPERATIONS

Constructor Summary

Constructors

Constructor	Description
WorkflowResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateWorkflow create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateWorkflow create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String name)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, UUID id)
Workflow	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
Workflow	getByName(javax.ws.rs.core.UriInfo uriInfo, String name, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
Workflow	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
void	initialize(OpenMetadataApplicationConfig config)	Method used for initializing a resource, such as creating default policies, roles, etc.
ResultList<Workflow>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include, String workflowType, String status)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	restoreWorkflow(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
PipelineServiceClientResponse	runAutomationsWorkflow(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	updateDescription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)

Methods inherited from class org.openmetadata.service.resources.EntityResource

addHref, addHref, addViewOperation, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getEntitySpecificOperations, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, listInternal, listInternal, listVersionsInternal, listVersionsInternal, patchInternal, restoreEntity, upgrade

Methods inherited from class java.lang.Object

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

Field Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

Constructor Details

WorkflowResource

public WorkflowResource(Authorizer authorizer)

Method Details

initialize

public void initialize(OpenMetadataApplicationConfig config)

Description copied from class: EntityResource

Method used for initializing a resource, such as creating default policies, roles, etc.

Overrides:

initialize in class EntityResource<Workflow,WorkflowRepository>

list

@GET
public ResultList<Workflow> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @DefaultValue("10") @QueryParam("limit") @Min(0L) @Max(1000000L)
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
 @QueryParam("before")
 String before,
 @QueryParam("after")
 String after,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include,
 @QueryParam("workflowType")
 String workflowType,
 @QueryParam("status")
 String status)

listVersions

@GET
@Path("/{id}/versions")
public EntityHistory listVersions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

get

@GET
@Path("/{id}")
public Workflow get(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("id")
 UUID id,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

getByName

@GET
@Path("/name/{name}")
public Workflow getByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("name")
 String name,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Workflow getVersion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @PathParam("version")
 String version)

create

@POST
public javax.ws.rs.core.Response create(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateWorkflow create)

runAutomationsWorkflow

@POST
@Path("/trigger/{id}")
public PipelineServiceClientResponse runAutomationsWorkflow(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("id")
 UUID id,
 @Context
 javax.ws.rs.core.SecurityContext securityContext)

updateDescription

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response updateDescription(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 javax.json.JsonPatch patch)

createOrUpdate

@PUT
public javax.ws.rs.core.Response createOrUpdate(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateWorkflow create)

delete

@DELETE
@Path("/{id}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @PathParam("id")
 UUID id)

delete

@DELETE
@Path("/name/{name}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @PathParam("name")
 String name)

restoreWorkflow

@PUT
@Path("/restore")
public javax.ws.rs.core.Response restoreWorkflow(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid RestoreEntity restore)