Package org.openmetadata.service

Class Entity

java.lang.Object

org.openmetadata.service.Entity

public final class Entity
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Entity.EntityList	Class for getting validated entity list from a queryParam with list of entities.

Field Summary

Fields

Modifier and Type	Field	Description
static List<String>	ACTIVITY_FEED_EXCLUDED_ENTITIES
static String	ADMIN_USER_NAME
static String	ALL_RESOURCES
static String	BOT
static String	CHART
static String	CLASSIFICATION
static String	CONTAINER
static String	DASHBOARD
static String	DASHBOARD_DATA_MODEL
static String	DASHBOARD_SERVICE
static String	DATA_INSIGHT_CHART
static String	DATABASE
static String	DATABASE_SCHEMA
static String	DATABASE_SERVICE
static String	EVENT_SUBSCRIPTION
static String	FIELD_DELETED
static String	FIELD_DESCRIPTION
static String	FIELD_DISPLAY_NAME
static String	FIELD_EXTENSION
static String	FIELD_FOLLOWERS
static String	FIELD_NAME
static String	FIELD_OWNER
static String	FIELD_PIPELINE_STATUS
static String	FIELD_REVIEWERS
static String	FIELD_TAGS
static String	FIELD_USAGE_SUMMARY
static String	FIELD_VOTES
static String	GLOSSARY
static String	GLOSSARY_TERM
static String	INGESTION_BOT_NAME
static String	INGESTION_BOT_ROLE
static String	INGESTION_PIPELINE
static String	KPI
static String	MESSAGING_SERVICE
static String	METADATA_SERVICE
static String	METRICS
static String	MLMODEL
static String	MLMODEL_SERVICE
static String	ORGANIZATION_NAME
static String	ORGANIZATION_POLICY_NAME
static String	PIPELINE
static String	PIPELINE_SERVICE
static String	POLICIES
static String	POLICY
static String	PROFILER_BOT_NAME
static String	PROFILER_BOT_ROLE
static String	QUALITY_BOT_NAME
static String	QUALITY_BOT_ROLE
static String	QUERY
static String	REPORT
static String	ROLE
static String	SEPARATOR
static String	STORAGE_SERVICE
static String	TABLE
static String	TAG
static String	TEAM
static String	TEST_CASE
static String	TEST_CONNECTION_DEFINITION
static String	TEST_DEFINITION
static String	TEST_SUITE
static String	THREAD
static String	TOPIC
static String	TYPE
static String	USER
static String	WEB_ANALYTIC_EVENT
static String	WORKFLOW

Method Summary

Modifier and Type	Method	Description
static void	deleteEntity(String updatedBy, String entityType, UUID entityId, boolean recursive, boolean hardDelete)
static <T> T	getEntity(String entityType, UUID id, String fields, Include include)
static <T> T	getEntity(String entityType, UUID id, String fields, Include include, boolean fromCache)	Retrieve the entity using id from given entity reference and fields
static <T> T	getEntity(EntityReference ref, String fields, Include include)
static <T> T	getEntity(MessageParser.EntityLink link, String fields, Include include)
static <T> T	getEntityByName(String entityType, String fqn, String fields, Include include)
static <T> T	getEntityByName(String entityType, String fqn, String fields, Include include, boolean fromCache)	Retrieve the entity using id from given entity reference and fields
static Class<? extends EntityInterface>	getEntityClassFromType(String entityType)
static <T> Set<String>	getEntityFields(Class<T> clz)	Get list of all the entity field names from JsonPropertyOrder annotation from generated java class from entity.json
static List<String>	getEntityList()
static EntityReference	getEntityReference(EntityReference ref, Include include)
static EntityReference	getEntityReferenceById(@NonNull String entityType, @NonNull UUID id, Include include)
static EntityReference	getEntityReferenceByName(@NonNull String entityType, String fqn, Include include)
static EntityRepository<? extends EntityInterface>	getEntityRepository(@NonNull String entityType)	Retrieve the corresponding entity repository for a given entity name.
static List<TagLabel>	getEntityTags(String entityType, EntityInterface entity)
static <T> String	getEntityTypeFromClass(Class<T> clz)
static String	getEntityTypeFromObject(Object object)
static EntityUtil.Fields	getFields(String entityType, List<String> fields)
static EntityReference	getOwner(@NonNull EntityReference reference)
static EntityRepository<? extends EntityInterface>	getServiceEntityRepository(@NonNull ServiceType serviceType)	Retrieve the corresponding entity repository for a given entity name.
static <T extends EntityInterface> void	registerEntity(Class<T> clazz, String entity, EntityRepository<T> entityRepository, List<MetadataOperation> entitySpecificOperations)
static void	restoreEntity(String updatedBy, String entityType, UUID entityId)
static boolean	shouldDisplayEntityChangeOnFeed(@NonNull String entityType)	Returns true if the change events of the given entity type should be published to the activity feed.
static boolean	supportsFeed(String entityType)	Returns true if the entity supports activity feeds, announcement, and tasks
static void	withHref(javax.ws.rs.core.UriInfo uriInfo, List<EntityReference> list)
static void	withHref(javax.ws.rs.core.UriInfo uriInfo, EntityReference ref)

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

FIELD_OWNER

public static final String FIELD_OWNER

See Also:

Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_FOLLOWERS

public static final String FIELD_FOLLOWERS

See Also:

Constant Field Values

FIELD_VOTES

public static final String FIELD_VOTES

See Also:

Constant Field Values

FIELD_TAGS

public static final String FIELD_TAGS

See Also:

Constant Field Values

FIELD_DELETED

public static final String FIELD_DELETED

See Also:

Constant Field Values

FIELD_PIPELINE_STATUS

public static final String FIELD_PIPELINE_STATUS

See Also:

Constant Field Values

FIELD_DISPLAY_NAME

public static final String FIELD_DISPLAY_NAME

See Also:

Constant Field Values

FIELD_EXTENSION

public static final String FIELD_EXTENSION

See Also:

Constant Field Values

FIELD_USAGE_SUMMARY

public static final String FIELD_USAGE_SUMMARY

See Also:

Constant Field Values

FIELD_REVIEWERS

public static final String FIELD_REVIEWERS

See Also:

Constant Field Values

DATABASE_SERVICE

public static final String DATABASE_SERVICE

See Also:

Constant Field Values

MESSAGING_SERVICE

public static final String MESSAGING_SERVICE

See Also:

Constant Field Values

DASHBOARD_SERVICE

public static final String DASHBOARD_SERVICE

See Also:

Constant Field Values

PIPELINE_SERVICE

public static final String PIPELINE_SERVICE

See Also:

Constant Field Values

STORAGE_SERVICE

public static final String STORAGE_SERVICE

See Also:

Constant Field Values

MLMODEL_SERVICE

public static final String MLMODEL_SERVICE

See Also:

Constant Field Values

METADATA_SERVICE

public static final String METADATA_SERVICE

See Also:

Constant Field Values

TABLE

public static final String TABLE

See Also:

Constant Field Values

DATABASE

public static final String DATABASE

See Also:

Constant Field Values

DATABASE_SCHEMA

public static final String DATABASE_SCHEMA

See Also:

Constant Field Values

METRICS

public static final String METRICS

See Also:

Constant Field Values

DASHBOARD

public static final String DASHBOARD

See Also:

Constant Field Values

DASHBOARD_DATA_MODEL

public static final String DASHBOARD_DATA_MODEL

See Also:

Constant Field Values

PIPELINE

public static final String PIPELINE

See Also:

Constant Field Values

CHART

public static final String CHART

See Also:

Constant Field Values

REPORT

public static final String REPORT

See Also:

Constant Field Values

TOPIC

public static final String TOPIC

See Also:

Constant Field Values

MLMODEL

public static final String MLMODEL

See Also:

Constant Field Values

CONTAINER

public static final String CONTAINER

See Also:

Constant Field Values

QUERY

public static final String QUERY

See Also:

Constant Field Values

GLOSSARY

public static final String GLOSSARY

See Also:

Constant Field Values

GLOSSARY_TERM

public static final String GLOSSARY_TERM

See Also:

Constant Field Values

TAG

public static final String TAG

See Also:

Constant Field Values

CLASSIFICATION

public static final String CLASSIFICATION

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

TEST_DEFINITION

public static final String TEST_DEFINITION

See Also:

Constant Field Values

TEST_CONNECTION_DEFINITION

public static final String TEST_CONNECTION_DEFINITION

See Also:

Constant Field Values

TEST_SUITE

public static final String TEST_SUITE

See Also:

Constant Field Values

KPI

public static final String KPI

See Also:

Constant Field Values

TEST_CASE

public static final String TEST_CASE

See Also:

Constant Field Values

WEB_ANALYTIC_EVENT

public static final String WEB_ANALYTIC_EVENT

See Also:

Constant Field Values

DATA_INSIGHT_CHART

public static final String DATA_INSIGHT_CHART

See Also:

Constant Field Values

POLICY

public static final String POLICY

See Also:

Constant Field Values

POLICIES

public static final String POLICIES

See Also:

Constant Field Values

ROLE

public static final String ROLE

See Also:

Constant Field Values

USER

public static final String USER

See Also:

Constant Field Values

TEAM

public static final String TEAM

See Also:

Constant Field Values

BOT

public static final String BOT

See Also:

Constant Field Values

INGESTION_PIPELINE

public static final String INGESTION_PIPELINE

See Also:

Constant Field Values

EVENT_SUBSCRIPTION

public static final String EVENT_SUBSCRIPTION

See Also:

Constant Field Values

THREAD

public static final String THREAD

See Also:

Constant Field Values

WORKFLOW

public static final String WORKFLOW

See Also:

Constant Field Values

ADMIN_USER_NAME

public static final String ADMIN_USER_NAME

See Also:

Constant Field Values

ORGANIZATION_NAME

public static final String ORGANIZATION_NAME

See Also:

Constant Field Values

ORGANIZATION_POLICY_NAME

public static final String ORGANIZATION_POLICY_NAME

See Also:

Constant Field Values

INGESTION_BOT_NAME

public static final String INGESTION_BOT_NAME

See Also:

Constant Field Values

INGESTION_BOT_ROLE

public static final String INGESTION_BOT_ROLE

See Also:

Constant Field Values

PROFILER_BOT_NAME

public static final String PROFILER_BOT_NAME

See Also:

Constant Field Values

PROFILER_BOT_ROLE

public static final String PROFILER_BOT_ROLE

See Also:

Constant Field Values

QUALITY_BOT_NAME

public static final String QUALITY_BOT_NAME

See Also:

Constant Field Values

QUALITY_BOT_ROLE

public static final String QUALITY_BOT_ROLE

See Also:

Constant Field Values

ALL_RESOURCES

public static final String ALL_RESOURCES

See Also:

Constant Field Values

ACTIVITY_FEED_EXCLUDED_ENTITIES

public static final List<String> ACTIVITY_FEED_EXCLUDED_ENTITIES

Method Detail

registerEntity

public static <T extends EntityInterface> void registerEntity(Class<T> clazz,
                                                              String entity,
                                                              EntityRepository<T> entityRepository,
                                                              List<MetadataOperation> entitySpecificOperations)

getEntityList

public static List<String> getEntityList()

getEntityReference

public static EntityReference getEntityReference(EntityReference ref,
                                                 Include include)

getEntityReferenceById

public static EntityReference getEntityReferenceById(@NonNull
                                                     @NonNull String entityType,
                                                     @NonNull
                                                     @NonNull UUID id,
                                                     Include include)

getEntityReferenceByName

public static EntityReference getEntityReferenceByName(@NonNull
                                                       @NonNull String entityType,
                                                       String fqn,
                                                       Include include)

getOwner

public static EntityReference getOwner(@NonNull
                                       @NonNull EntityReference reference)

withHref

public static void withHref(javax.ws.rs.core.UriInfo uriInfo,
                            List<EntityReference> list)

withHref

public static void withHref(javax.ws.rs.core.UriInfo uriInfo,
                            EntityReference ref)

shouldDisplayEntityChangeOnFeed

public static boolean shouldDisplayEntityChangeOnFeed(@NonNull
                                                      @NonNull String entityType)

Returns true if the change events of the given entity type should be published to the activity feed.

getFields

public static EntityUtil.Fields getFields(String entityType,
                                          List<String> fields)

getEntity

public static <T> T getEntity(EntityReference ref,
                              String fields,
                              Include include)

getEntity

public static <T> T getEntity(MessageParser.EntityLink link,
                              String fields,
                              Include include)

getEntity

public static <T> T getEntity(String entityType,
                              UUID id,
                              String fields,
                              Include include,
                              boolean fromCache)

Retrieve the entity using id from given entity reference and fields

getEntity

public static <T> T getEntity(String entityType,
                              UUID id,
                              String fields,
                              Include include)

getEntityByName

public static <T> T getEntityByName(String entityType,
                                    String fqn,
                                    String fields,
                                    Include include,
                                    boolean fromCache)

Retrieve the entity using id from given entity reference and fields

getEntityByName

public static <T> T getEntityByName(String entityType,
                                    String fqn,
                                    String fields,
                                    Include include)

getEntityRepository

public static EntityRepository<? extends EntityInterface> getEntityRepository(@NonNull
                                                                              @NonNull String entityType)

Retrieve the corresponding entity repository for a given entity name.

getServiceEntityRepository

public static EntityRepository<? extends EntityInterface> getServiceEntityRepository(@NonNull
                                                                                     @NonNull ServiceType serviceType)

Retrieve the corresponding entity repository for a given entity name.

getEntityTags

public static List<TagLabel> getEntityTags(String entityType,
                                           EntityInterface entity)

deleteEntity

public static void deleteEntity(String updatedBy,
                                String entityType,
                                UUID entityId,
                                boolean recursive,
                                boolean hardDelete)

restoreEntity

public static void restoreEntity(String updatedBy,
                                 String entityType,
                                 UUID entityId)

getEntityTypeFromClass

public static <T> String getEntityTypeFromClass(Class<T> clz)

getEntityTypeFromObject

public static String getEntityTypeFromObject(Object object)

getEntityClassFromType

public static Class<? extends EntityInterface> getEntityClassFromType(String entityType)

getEntityFields

public static <T> Set<String> getEntityFields(Class<T> clz)

Get list of all the entity field names from JsonPropertyOrder annotation from generated java class from entity.json

supportsFeed

public static boolean supportsFeed(String entityType)

Returns true if the entity supports activity feeds, announcement, and tasks