Package org.openmetadata.service.resources.lineage

Class LineageResource

java.lang.Object

org.openmetadata.service.resources.lineage.LineageResource

@Path("/v1/lineage")
@Produces("application/json")
@Consumes("application/json")
public class LineageResource
extends Object

Constructor Summary

Constructors

Constructor	Description
LineageResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addLineage(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid AddLineage addLineage)
javax.ws.rs.core.Response	deleteLineage(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fromEntity, String fromId, String toEntity, String toId)
javax.ws.rs.core.Response	deleteLineageByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fromEntity, String fromFQN, String toEntity, String toFQN)
String	exportLineage(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, int upstreamDepth, int downstreamDepth, String queryFilter, boolean deleted, String entityType)
@Valid EntityLineage	get(javax.ws.rs.core.UriInfo uriInfo, String entity, String id, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int upstreamDepth, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int downStreamDepth)
@Valid EntityLineage	getByName(javax.ws.rs.core.UriInfo uriInfo, String entity, String fqn, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int upstreamDepth, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int downStreamDepth)
javax.ws.rs.core.Response	getLineageEdge(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID fromId, UUID toId)
javax.ws.rs.core.Response	patchLineageEdge(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fromEntity, UUID fromId, String toEntity, UUID toId, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	searchLineage(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, int upstreamDepth, int downstreamDepth, String queryFilter, boolean deleted, String entityType)

Methods inherited from class java.lang.Object

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

Constructor Details

LineageResource

public LineageResource(Authorizer authorizer)

Method Details

get

@GET
@Valid
@Path("/{entity}/{id}")
public @Valid EntityLineage get(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("entity")
 String entity,
 @PathParam("id")
 String id,
 @DefaultValue("1") @Min(0L) @Max(3L) @QueryParam("upstreamDepth")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int upstreamDepth,
 @DefaultValue("1") @Min(0L) @Max(3L) @QueryParam("downstreamDepth")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int downStreamDepth)

getByName

@GET
@Valid
@Path("/{entity}/name/{fqn}")
public @Valid EntityLineage getByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("entity")
 String entity,
 @PathParam("fqn")
 String fqn,
 @DefaultValue("1") @Min(0L) @Max(3L) @QueryParam("upstreamDepth")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int upstreamDepth,
 @DefaultValue("1") @Min(0L) @Max(3L) @QueryParam("downstreamDepth")
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(3L) int downStreamDepth)

searchLineage

@GET
@Path("/getLineage")
public javax.ws.rs.core.Response searchLineage(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fqn")
 String fqn,
 @QueryParam("upstreamDepth")
 int upstreamDepth,
 @QueryParam("downstreamDepth")
 int downstreamDepth,
 @QueryParam("query_filter")
 String queryFilter,
 @QueryParam("includeDeleted")
 boolean deleted,
 @QueryParam("type")
 String entityType)
                                        throws IOException

Throws:

IOException

exportLineage

@GET
@Path("/export")
@Produces("text/plain")
public String exportLineage(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fqn")
 String fqn,
 @QueryParam("upstreamDepth")
 int upstreamDepth,
 @QueryParam("downstreamDepth")
 int downstreamDepth,
 @QueryParam("query_filter")
 String queryFilter,
 @QueryParam("includeDeleted")
 boolean deleted,
 @QueryParam("type")
 String entityType)
                     throws IOException

Throws:

IOException

addLineage

@PUT
public javax.ws.rs.core.Response addLineage(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid AddLineage addLineage)

getLineageEdge

@GET
@Path("/getLineageEdge/{fromId}/{toId}")
public javax.ws.rs.core.Response getLineageEdge(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fromId")
 UUID fromId,
 @PathParam("toId")
 UUID toId)

patchLineageEdge

@Path("/{fromEntity}/{fromId}/{toEntity}/{toId}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patchLineageEdge(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fromEntity")
 String fromEntity,
 @PathParam("fromId")
 UUID fromId,
 @PathParam("toEntity")
 String toEntity,
 @PathParam("toId")
 UUID toId,
 javax.json.JsonPatch patch)

deleteLineage

@DELETE
@Path("/{fromEntity}/{fromId}/{toEntity}/{toId}")
public javax.ws.rs.core.Response deleteLineage(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fromEntity")
 String fromEntity,
 @PathParam("fromId")
 String fromId,
 @PathParam("toEntity")
 String toEntity,
 @PathParam("toId")
 String toId)

deleteLineageByName

@DELETE
@Path("/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}")
public javax.ws.rs.core.Response deleteLineageByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fromEntity")
 String fromEntity,
 @PathParam("fromFQN")
 String fromFQN,
 @PathParam("toEntity")
 String toEntity,
 @PathParam("toFQN")
 String toFQN)