Package org.openmetadata.service.jdbi3

Class IngestionPipelineRepository

java.lang.Object

org.openmetadata.service.jdbi3.EntityRepository<IngestionPipeline>

org.openmetadata.service.jdbi3.IngestionPipelineRepository

public class IngestionPipelineRepository
extends EntityRepository<IngestionPipeline>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IngestionPipelineRepository.IngestionPipelineUpdater	Handles entity updated from PUT and POST operation.

Nested classes/interfaces inherited from class org.openmetadata.service.jdbi3.EntityRepository

EntityRepository.EntityUpdater, EntityRepository.Operation

Field Summary

Fields inherited from class org.openmetadata.service.jdbi3.EntityRepository

allowedFields, CACHE_WITH_ID, CACHE_WITH_NAME, dao, daoCollection, entityType, putFields, quoteFqn, supportsExtension, supportsFollower, supportsOwner, supportsSoftDelete, supportsTags, supportsVotes

Constructor Summary

Constructors

Constructor	Description
IngestionPipelineRepository(CollectionDAO dao)

Method Summary

Modifier and Type	Method	Description
RestUtil.PutResponse<?>	addPipelineStatus(javax.ws.rs.core.UriInfo uriInfo, String fqn, PipelineStatus pipelineStatus)
IngestionPipeline	clearFields(IngestionPipeline ingestionPipeline, EntityUtil.Fields fields)	Set the requested fields in an entity.
IngestionPipeline	deletePipelineStatus(UUID ingestionPipelineId)
PipelineStatus	getLatestPipelineStatus(IngestionPipeline ingestionPipeline)
PipelineStatus	getPipelineStatus(String ingestionPipelineFQN, UUID pipelineStatusRunId)
EntityRepository.EntityUpdater	getUpdater(IngestionPipeline original, IngestionPipeline updated, EntityRepository.Operation operation)
ResultList<PipelineStatus>	listPipelineStatus(String ingestionPipelineFQN, Long startTs, Long endTs)
protected void	postDelete(IngestionPipeline entity)
void	prepare(IngestionPipeline ingestionPipeline)	This method is used for validating an entity to be created during POST, PUT, and PATCH operations and prepare the entity with all the required attributes and relationships.
IngestionPipeline	setFields(IngestionPipeline ingestionPipeline, EntityUtil.Fields fields)	Set the requested fields in an entity.
void	setFullyQualifiedName(IngestionPipeline ingestionPipeline)	Set fullyQualifiedName of an entity
void	setPipelineServiceClient(PipelineServiceClient client)
void	storeEntity(IngestionPipeline ingestionPipeline, boolean update)	An entity is stored in the backend database as JSON document.
void	storeRelationships(IngestionPipeline ingestionPipeline)	This method is called to store all the relationships of an entity.
static void	validateProfileSample(IngestionPipeline ingestionPipeline)

Methods inherited from class org.openmetadata.service.jdbi3.EntityRepository

addDerivedTags, addFollower, addRelationship, addRelationship, addRelationship, applyTags, applyTags, bulkAddToRelationship, checkSystemEntityDeletion, cleanup, clearFieldsInternal, create, createInternal, createOrUpdate, createOrUpdateInternal, delete, deleteByName, deleteExtensionAtTimestamp, deleteExtensionBeforeTimestamp, deleteFollower, deleteFrom, deleteInternal, deleteInternalByName, deleteRelationship, deleteTo, ensureSingleRelationship, exportToCsv, find, findBoth, findByName, findByNameOrNull, findFrom, findFromRecords, findTo, findToRecords, get, get, getAllowedFieldsCopy, getAllTags, getByName, getByName, getChildren, getCommonFields, getContainer, getCustomPropertyFQN, getCustomPropertyFQNPrefix, getEntitiesFromSeedData, getEntitiesFromSeedData, getEntitiesFromSeedData, getExtension, getExtensionAtTimestamp, getExtensionAtTimestampWithOperation, getFields, getFields, getFollowers, getFromEntityRef, getHref, getIngestionPipelines, getLatestExtensionFromTimeseries, getOwner, getOwner, getParent, getReference, getReferenceByName, getResultList, getResultList, getResultsFromAndToTimestamps, getResultsFromAndToTimestamps, getReviewers, getTags, getTags, getToEntityRef, getVersion, getVotes, importFromCsv, initializeEntity, initSeedDataFromResources, listAfter, listAfterWithSkipFailure, listAll, listBefore, listVersions, patch, populateOwner, postCreate, postUpdate, preDelete, prepareInternal, removeExtension, restoreEntity, restorePatchAttributes, setFieldsInternal, setInheritedFields, store, storeExtension, storeOwner, storeRelationshipsInternal, storeTimeSeries, storeTimeSeriesWithOperation, update, update, updateOwner, updateVote, validateOwner, validateRoles, validateUsers, withHref

Methods inherited from class java.lang.Object

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

Constructor Detail

IngestionPipelineRepository

public IngestionPipelineRepository(CollectionDAO dao)

Method Detail

setFullyQualifiedName

public void setFullyQualifiedName(IngestionPipeline ingestionPipeline)

Description copied from class: EntityRepository

Set fullyQualifiedName of an entity

Overrides:

setFullyQualifiedName in class EntityRepository<IngestionPipeline>

setFields

public IngestionPipeline setFields(IngestionPipeline ingestionPipeline,
                                   EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.

Specified by:

setFields in class EntityRepository<IngestionPipeline>

clearFields

public IngestionPipeline clearFields(IngestionPipeline ingestionPipeline,
                                     EntityUtil.Fields fields)

Description copied from class: EntityRepository

Set the requested fields in an entity. This is used for requesting specific fields in the object during GET operations. It is also used during PUT and PATCH operations to set up fields that can be updated.

Specified by:

clearFields in class EntityRepository<IngestionPipeline>

prepare

public void prepare(IngestionPipeline ingestionPipeline)

Description copied from class: EntityRepository

This method is used for validating an entity to be created during POST, PUT, and PATCH operations and prepare the entity with all the required attributes and relationships.

The implementation of this method must perform the following:

1. Prepare the values for attributes that are not required in the request but can be derived on the server side. Example - >FullyQualifiedNames of an entity can be derived from the hierarchy that an entity belongs to .
2. Validate all the attributes of an entity.
3. Validate all the relationships of an entity. As an example - during table creation, relationships such as Tags, Owner, Databasea table belongs to are validated. During validation additional information that is not required in the create/update request are set up in the corresponding relationship fields.

At the end of this operation, entity is expected to be valid and fully constructed with all the fields that will be sent as payload in the POST, PUT, and PATCH operations response.

Specified by:

prepare in class EntityRepository<IngestionPipeline>

See Also:

for an example implementation

deletePipelineStatus

public IngestionPipeline deletePipelineStatus(UUID ingestionPipelineId)

storeEntity

public void storeEntity(IngestionPipeline ingestionPipeline,
                        boolean update)

Description copied from class: EntityRepository

An entity is stored in the backend database as JSON document. The JSON includes some attributes of the entity and does not include attributes such as href. The relationship fields of an entity is never stored in the JSON document. It is always reconstructed based on relationship edges from the backend database.

As an example, when table entity is stored, the attributes such as href and the relationships such as owner, database, and tags are set to null. These attributes are restored back after the JSON document is stored to be sent as response.

Specified by:

storeEntity in class EntityRepository<IngestionPipeline>

See Also:

for an example implementation

storeRelationships

public void storeRelationships(IngestionPipeline ingestionPipeline)

Description copied from class: EntityRepository

This method is called to store all the relationships of an entity. It is expected that all relationships are already validated and completely setup before this method is called and no validation of relationships is required.

Specified by:

storeRelationships in class EntityRepository<IngestionPipeline>

See Also:

for an example implementation

getUpdater

public EntityRepository.EntityUpdater getUpdater(IngestionPipeline original,
                                                 IngestionPipeline updated,
                                                 EntityRepository.Operation operation)

Overrides:

getUpdater in class EntityRepository<IngestionPipeline>

postDelete

protected void postDelete(IngestionPipeline entity)

Overrides:

postDelete in class EntityRepository<IngestionPipeline>

setPipelineServiceClient

public void setPipelineServiceClient(PipelineServiceClient client)

addPipelineStatus

public RestUtil.PutResponse<?> addPipelineStatus(javax.ws.rs.core.UriInfo uriInfo,
                                                 String fqn,
                                                 PipelineStatus pipelineStatus)

listPipelineStatus

public ResultList<PipelineStatus> listPipelineStatus(String ingestionPipelineFQN,
                                                     Long startTs,
                                                     Long endTs)

getLatestPipelineStatus

public PipelineStatus getLatestPipelineStatus(IngestionPipeline ingestionPipeline)

getPipelineStatus

public PipelineStatus getPipelineStatus(String ingestionPipelineFQN,
                                        UUID pipelineStatusRunId)

validateProfileSample

public static void validateProfileSample(IngestionPipeline ingestionPipeline)