Package org.openmetadata.service.resources.services.ingestionpipelines

Class IngestionPipelineResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<IngestionPipeline,IngestionPipelineRepository>

org.openmetadata.service.resources.services.ingestionpipelines.IngestionPipelineResource

@Path("/v1/services/ingestionPipelines")
@Produces("application/json")
@Consumes("application/json")
public class IngestionPipelineResource
extends EntityResource<IngestionPipeline,IngestionPipelineRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IngestionPipelineResource.IngestionPipelineList

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
IngestionPipelineResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
IngestionPipeline	addHref(javax.ws.rs.core.UriInfo uriInfo, IngestionPipeline ingestionPipeline)
javax.ws.rs.core.Response	addPipelineStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, @Valid PipelineStatus pipelineStatus)
List<PipelineServiceClientResponse>	bulkDeployIngestion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid List<UUID> pipelineIdList)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateIngestionPipeline create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateIngestionPipeline update)
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)
IngestionPipeline	deletePipelineStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
PipelineServiceClientResponse	deployIngestion(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext)
IngestionPipeline	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
IngestionPipeline	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
javax.ws.rs.core.Response	getHostIp(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
javax.ws.rs.core.Response	getLastIngestionLogs(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String after)
PipelineStatus	getPipelineStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, UUID runId)
PipelineServiceClientResponse	getRESTStatus(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext)
IngestionPipeline	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.
PipelineServiceClientResponse	killIngestion(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext)
@Valid ResultList<IngestionPipeline>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String serviceParam, String testSuiteParam, String pipelineType, String serviceType, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
ResultList<PipelineStatus>	listPipelineStatuses(javax.ws.rs.core.SecurityContext securityContext, String fqn, @NonNull Long startTs, @NonNull Long endTs)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	restoreIngestionPipeline(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
javax.ws.rs.core.Response	toggleIngestion(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext)
PipelineServiceClientResponse	triggerIngestion(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext)
PipelineServiceClientResponse	triggerPipelineInternal(UUID id, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String botName)
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, 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

IngestionPipelineResource

public IngestionPipelineResource(Authorizer authorizer)

Method Details

addHref

public IngestionPipeline addHref(javax.ws.rs.core.UriInfo uriInfo,
 IngestionPipeline ingestionPipeline)

Overrides:

addHref in class EntityResource<IngestionPipeline,IngestionPipelineRepository>

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<IngestionPipeline,IngestionPipelineRepository>

list

@GET
@Valid
public @Valid ResultList<IngestionPipeline> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("service")
 String serviceParam,
 @QueryParam("testSuite")
 String testSuiteParam,
 @QueryParam("pipelineType")
 String pipelineType,
 @QueryParam("serviceType")
 String serviceType,
 @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 IngestionPipeline 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)

getVersion

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

getByName

@GET
@Path("/name/{fqn}")
public IngestionPipeline 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)

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 CreateIngestionPipeline 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 CreateIngestionPipeline update)

deployIngestion

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

bulkDeployIngestion

@POST
@Path("/bulk/deploy")
public List<PipelineServiceClientResponse> bulkDeployIngestion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid List<UUID> pipelineIdList)

triggerIngestion

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

toggleIngestion

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

killIngestion

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

getHostIp

@GET
@Path("/ip")
public javax.ws.rs.core.Response getHostIp(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext)

getRESTStatus

@GET
@Path("/status")
public PipelineServiceClientResponse getRESTStatus(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext)

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)

restoreIngestionPipeline

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

getLastIngestionLogs

@GET
@Path("/logs/{id}/last")
public javax.ws.rs.core.Response getLastIngestionLogs(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @QueryParam("after")
 String after)

addPipelineStatus

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

listPipelineStatuses

@GET
@Path("/{fqn}/pipelineStatus")
public ResultList<PipelineStatus> listPipelineStatuses(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fqn")
 String fqn,
 @NonNull @QueryParam("startTs")
 @NonNull Long startTs,
 @NonNull @QueryParam("endTs")
 @NonNull Long endTs)

getPipelineStatus

@GET
@Path("/{fqn}/pipelineStatus/{id}")
public PipelineStatus getPipelineStatus(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fqn")
 String fqn,
 @PathParam("id")
 UUID runId)

deletePipelineStatus

@DELETE
@Path("/{id}/pipelineStatus")
public IngestionPipeline deletePipelineStatus(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

triggerPipelineInternal

public PipelineServiceClientResponse triggerPipelineInternal(UUID id,
 javax.ws.rs.core.UriInfo uriInfo,
 javax.ws.rs.core.SecurityContext securityContext,
 String botName)