Package org.openmetadata.service.resources.pipelines

Class PipelineResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Pipeline,PipelineRepository>

org.openmetadata.service.resources.pipelines.PipelineResource

@Path("/v1/pipelines")
@Produces("application/json")
@Consumes("application/json")
public class PipelineResource
extends EntityResource<Pipeline,PipelineRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineResource.PipelineList
static class	PipelineResource.PipelineStatusList

Field Summary

Fields

Modifier and Type	Field	Description
static 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
PipelineResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, UUID userId)
Pipeline	addHref(javax.ws.rs.core.UriInfo uriInfo, Pipeline pipeline)
Pipeline	addPipelineStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, @Valid PipelineStatus pipelineStatus)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreatePipeline create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreatePipeline create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String fqn)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, UUID id)
javax.ws.rs.core.Response	deleteFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, UUID userId)
Pipeline	deletePipelineStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, Long timestamp)
Pipeline	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Pipeline	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
Pipeline	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<PipelineStatus>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, @NotNull Long startTs, @NotNull Long endTs)
@Valid ResultList<Pipeline>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String serviceParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	restorePipeline(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
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, addViewOperation, copy, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, initialize, 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 Detail

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

Constructor Detail

PipelineResource

public PipelineResource(CollectionDAO dao,
                        Authorizer authorizer)

Method Detail

addHref

public Pipeline addHref(javax.ws.rs.core.UriInfo uriInfo,
                        Pipeline pipeline)

Specified by:

addHref in class EntityResource<Pipeline,PipelineRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Pipeline,PipelineRepository>

list

@GET
@Valid
public @Valid ResultList<Pipeline> list(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        @Context
                                        javax.ws.rs.core.SecurityContext securityContext,
                                        @QueryParam("fields")
                                        String fieldsParam,
                                        @QueryParam("service")
                                        String serviceParam,
                                        @DefaultValue("10") @Min(0L) @Max(1000000L) @QueryParam("limit")
                                        @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)

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 Pipeline get(@Context
                    javax.ws.rs.core.UriInfo uriInfo,
                    @Context
                    javax.ws.rs.core.SecurityContext securityContext,
                    @PathParam("id")
                    UUID id,
                    @QueryParam("fields")
                    String fieldsParam,
                    @QueryParam("include") @DefaultValue("non-deleted")
                    Include include)

getByName

@GET
@Path("/name/{fqn}")
public Pipeline getByName(@Context
                          javax.ws.rs.core.UriInfo uriInfo,
                          @PathParam("fqn")
                          String fqn,
                          @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 Pipeline 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 CreatePipeline create)

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 CreatePipeline create)

addPipelineStatus

@PUT
@Path("/{fqn}/status")
public Pipeline addPipelineStatus(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  @Context
                                  javax.ws.rs.core.SecurityContext securityContext,
                                  @PathParam("fqn")
                                  String fqn,
                                  @Valid
                                  @Valid PipelineStatus pipelineStatus)

list

@GET
@Path("/{fqn}/status")
public ResultList<PipelineStatus> list(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.ws.rs.core.SecurityContext securityContext,
                                       @PathParam("fqn")
                                       String fqn,
                                       @NotNull @QueryParam("startTs")
                                       @NotNull Long startTs,
                                       @NotNull @QueryParam("endTs")
                                       @NotNull Long endTs)

deletePipelineStatus

@DELETE
@Path("/{fqn}/status/{timestamp}")
public Pipeline deletePipelineStatus(@Context
                                     javax.ws.rs.core.UriInfo uriInfo,
                                     @Context
                                     javax.ws.rs.core.SecurityContext securityContext,
                                     @PathParam("fqn")
                                     String fqn,
                                     @PathParam("timestamp")
                                     Long timestamp)

addFollower

@PUT
@Path("/{id}/followers")
public javax.ws.rs.core.Response addFollower(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @PathParam("id")
                                             UUID id,
                                             UUID userId)

deleteFollower

@DELETE
@Path("/{id}/followers/{userId}")
public javax.ws.rs.core.Response deleteFollower(@Context
                                                javax.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.ws.rs.core.SecurityContext securityContext,
                                                @PathParam("id")
                                                UUID id,
                                                @PathParam("userId")
                                                UUID userId)

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/{fqn}")
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("fqn")
                                        String fqn)

restorePipeline

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