Share via


Azure.Analytics.Purview.DataMap Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Classes

AnalyticsPurviewDataMapModelFactory

Model factory for models.

AtlasAttributeDef

class that captures details of a struct-attribute.

AtlasBusinessMetadataDef

class that captures details of a struct-type.

AtlasClassification

An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.

AtlasClassificationDef

class that captures details of a classification-type.

AtlasClassifications

REST serialization friendly list.

AtlasConstraintDef

class that captures details of a constraint.

AtlasDateFormat

The date format.

AtlasEntitiesWithExtInfo

An instance of an entity along with extended info - like hive_table, hive_database.

AtlasEntity

An instance of an entity - like hive_table, hive_database.

AtlasEntityDef

class that captures details of a entity-type.

AtlasEntityHeader

An instance of an entity - like hive_table, hive_database.

AtlasEntityHeaders

An instance of an entity header map.

AtlasEntityWithExtInfo

An instance of an entity along with extended info - like hive_table, hive_database.

AtlasEnumDef

class that captures details of an enum-type.

AtlasEnumElementDef

class that captures details of an enum-element.

AtlasGlossary

The glossary object.

AtlasGlossaryCategory

The glossary category.

AtlasGlossaryExtInfo

The extended information of glossary.

AtlasGlossaryHeader

The glossary header with basic information.

AtlasGlossaryTerm

The glossary term.

AtlasLineageInfo

The lineage information.

AtlasNumberFormat

The number format.

AtlasObjectId

Reference to an object-instance of a type - like entity.

AtlasRelatedCategoryHeader

The header of the related category.

AtlasRelatedObjectId

Reference to an object-instance of AtlasEntity type used in relationship attribute values

AtlasRelatedTermHeader

The header of the related term.

AtlasRelationship

Atlas relationship instance.

AtlasRelationshipAttributeDef

The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.

AtlasRelationshipDef

AtlasRelationshipDef is a TypeDef that defines a relationship. As with other typeDefs the AtlasRelationshipDef has a name. Once created the RelationshipDef has a guid. The name and the guid are the 2 ways that the RelationshipDef is identified. RelationshipDefs have 2 ends, each of which specify cardinality, an EntityDef type name and name and optionally whether the end is a container. RelationshipDefs can have AttributeDefs - though only primitive types are allowed. RelationshipDefs have a relationshipCategory specifying the UML type of relationship required The way EntityDefs and RelationshipDefs are intended to be used is that EntityDefs will define AttributeDefs these AttributeDefs will not specify an EntityDef type name as their types. RelationshipDefs introduce new attributes to the entity instances. For example EntityDef A might have attributes attr1,attr2,attr3

EntityDef B might have attributes attr4,attr5,attr6 RelationshipDef AtoB might define 2 ends

end1: type A, name attr7 end2: type B, name attr8

When an instance of EntityDef A is created, it will have attributes attr1,attr2,attr3,attr7 When an instance of EntityDef B is created, it will have attributes attr4,attr5,attr6,attr8

In this way relationshipDefs can be authored separately from entityDefs and can inject relationship attributes into the entity instances

AtlasRelationshipEndDef

The relationshipEndDef represents an end of the relationship. The end of the relationship is defined by a type, an attribute name, cardinality and whether it is the container end of the relationship.

AtlasRelationshipWithExtInfo

The relationship with extended information.

AtlasStruct

Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.

AtlasStructDef

class that captures details of a struct-type.

AtlasTermAssignmentHeader

The header for term assignment.

AtlasTermCategorizationHeader

The basic information for term categorization.

AtlasTimeZone

The timezone information.

AtlasTypeDef

The definitions of type.

AtlasTypeDefHeader

The basic information of the type definition.

AtlasTypesDef

The definitions of types.

AutoCompleteConfig

The payload of autocomplete request.

AutoCompleteResult

The result of the autocomplete request.

AutoCompleteResultValue

The value item of the autocomplete suggest.

BulkImportResult

Bulk import result.

BusinessMetadataOptions

Business metadata to send to the service.

ClassificationAssociateConfig

The request payload for classification association.

ContactInfo

ContactInfo.

ContactSearchResultValue

The contact in the search and suggest result.

DataMapClient

The DataMap service client.

DataMapClientOptions

Client options for DataMapClient.

Discovery

The Discovery sub-client.

Entity

The Entity sub-client.

EntityMutationResult

The mutation response result of entity.

Glossary

The Glossary sub-client.

ImportInfo

ImportInfo.

Lineage

The Lineage sub-client.

LineageRelation

The lineage relation with GUID of the from and to entity.

MoveEntitiesConfig

MoveEntitiesOptions.

ParentRelation

The lineage parents relation with GUID of the parent entity and to child entity.

PurviewObjectId

PurviewObjectId.

QueryConfig

The search query of advanced search request.

QueryResult

The result of the search result.

Relationship

The Relationship sub-client.

ResourceLink

ResourceLink.

SearchFacetItem

The content of a search facet result item.

SearchFacetItemValue

The content of a search facet result item.

SearchFacetResultValue

A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet is returned as an element of @search.facets.

SearchFacetSort

The sorting criteria.

SearchHighlights

A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.

SearchResultValue

The value item of the search result.

SearchTaxonomySetting

Taxonomy setting for search request.

SuggestConfig

The payload of suggest request.

SuggestResult

The result item of the search suggest.

SuggestResultValue

The value item of the search suggest.

TermSearchResultValue

The context.

TermTemplateDef

Term template definition for glossary term.

TimeBoundary

Captures time-boundary details.

TypeDefinition

The TypeDefinition sub-client.

Structs

AtlasSortType

Type for sorting.

AtlasTermAssignmentStatus

Status for term assignment.

AtlasTermRelationshipStatus

Status for atlas term relationship.

BusinessAttributeUpdateBehavior

Enum for business attribute update behavior.

CardinalityValue

Cardinality.

EntityStatus

Status - can be active or deleted.

ImportStatus

Status for import.

LineageDirection

Lineage direction.

RelationshipCategory

Relationship Category.

RoundingMode

Rounding Mode.

SearchSortOrder

Search sort order.

StatusAtlasRelationship

Status for atlas relationship.

TermStatus

Status for term.

TypeCategory

Type Category.

Enums

DataMapClientOptions.ServiceVersion

The version of the service to use.