TypeDefinition Class

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

Azure.Analytics.Purview.DataMap v1.0.0-beta.1

Source:

TypeDefinition.cs

The TypeDefinition sub-client.

public class TypeDefinition

type TypeDefinition = class

Public Class TypeDefinition

Inheritance

Object

TypeDefinition

Constructors

TypeDefinition()

Initializes a new instance of TypeDefinition for mocking.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

BatchCreate(AtlasTypesDef, CancellationToken)	Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.
BatchCreate(RequestContent, RequestContext)	[Protocol Method] Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler BatchCreate(AtlasTypesDef, CancellationToken) convenience overload with strongly typed models first.
BatchCreateAsync(AtlasTypesDef, CancellationToken)	Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.
BatchCreateAsync(RequestContent, RequestContext)	[Protocol Method] Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler BatchCreateAsync(AtlasTypesDef, CancellationToken) convenience overload with strongly typed models first.
BatchDelete(AtlasTypesDef, CancellationToken)	Delete API for all types in bulk.
BatchDelete(RequestContent, RequestContext)	[Protocol Method] Delete API for all types in bulk. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler BatchDelete(AtlasTypesDef, CancellationToken) convenience overload with strongly typed models first.
BatchDeleteAsync(AtlasTypesDef, CancellationToken)	Delete API for all types in bulk.
BatchDeleteAsync(RequestContent, RequestContext)	[Protocol Method] Delete API for all types in bulk. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler BatchDeleteAsync(AtlasTypesDef, CancellationToken) convenience overload with strongly typed models first.
BatchUpdate(AtlasTypesDef, CancellationToken)	Update all types in bulk, changes detected in the type definitions would be persisted.
BatchUpdate(RequestContent, RequestContext)	[Protocol Method] Update all types in bulk, changes detected in the type definitions would be persisted. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler BatchUpdate(AtlasTypesDef, CancellationToken) convenience overload with strongly typed models first.
BatchUpdateAsync(AtlasTypesDef, CancellationToken)	Update all types in bulk, changes detected in the type definitions would be persisted.
BatchUpdateAsync(RequestContent, RequestContext)	[Protocol Method] Update all types in bulk, changes detected in the type definitions would be persisted. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler BatchUpdateAsync(AtlasTypesDef, CancellationToken) convenience overload with strongly typed models first.
Delete(String, RequestContext)	[Protocol Method] Delete API for type identified by its name. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteAsync(String, RequestContext)	[Protocol Method] Delete API for type identified by its name. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetBusinessMetadataById(String, CancellationToken)	Get the businessMetadata definition for the given guid.
GetBusinessMetadataById(String, RequestContext)	[Protocol Method] Get the businessMetadata definition for the given guid. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetBusinessMetadataById(String, CancellationToken) convenience overload with strongly typed models first.
GetBusinessMetadataByIdAsync(String, CancellationToken)	Get the businessMetadata definition for the given guid.
GetBusinessMetadataByIdAsync(String, RequestContext)	[Protocol Method] Get the businessMetadata definition for the given guid. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetBusinessMetadataByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetBusinessMetadataByName(String, CancellationToken)	Get the businessMetadata definition by it's name (unique).
GetBusinessMetadataByName(String, RequestContext)	[Protocol Method] Get the businessMetadata definition by it's name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetBusinessMetadataByName(String, CancellationToken) convenience overload with strongly typed models first.
GetBusinessMetadataByNameAsync(String, CancellationToken)	Get the businessMetadata definition by it's name (unique).
GetBusinessMetadataByNameAsync(String, RequestContext)	[Protocol Method] Get the businessMetadata definition by it's name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetBusinessMetadataByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetById(String, CancellationToken)	Get the type definition for the given GUID.
GetById(String, RequestContext)	[Protocol Method] Get the type definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetById(String, CancellationToken) convenience overload with strongly typed models first.
GetByIdAsync(String, CancellationToken)	Get the type definition for the given GUID.
GetByIdAsync(String, RequestContext)	[Protocol Method] Get the type definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetByName(String, CancellationToken)	Get the type definition by its name (unique).
GetByName(String, RequestContext)	[Protocol Method] Get the type definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetByName(String, CancellationToken) convenience overload with strongly typed models first.
GetByNameAsync(String, CancellationToken)	Get the type definition by its name (unique).
GetByNameAsync(String, RequestContext)	[Protocol Method] Get the type definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetClassificationById(String, CancellationToken)	Get the classification definition for the given GUID.
GetClassificationById(String, RequestContext)	[Protocol Method] Get the classification definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetClassificationById(String, CancellationToken) convenience overload with strongly typed models first.
GetClassificationByIdAsync(String, CancellationToken)	Get the classification definition for the given GUID.
GetClassificationByIdAsync(String, RequestContext)	[Protocol Method] Get the classification definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetClassificationByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetClassificationByName(String, CancellationToken)	Get the classification definition by its name (unique).
GetClassificationByName(String, RequestContext)	[Protocol Method] Get the classification definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetClassificationByName(String, CancellationToken) convenience overload with strongly typed models first.
GetClassificationByNameAsync(String, CancellationToken)	Get the classification definition by its name (unique).
GetClassificationByNameAsync(String, RequestContext)	[Protocol Method] Get the classification definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetClassificationByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetEntityById(String, CancellationToken)	Get the Entity definition for the given GUID.
GetEntityById(String, RequestContext)	[Protocol Method] Get the Entity definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEntityById(String, CancellationToken) convenience overload with strongly typed models first.
GetEntityByIdAsync(String, CancellationToken)	Get the Entity definition for the given GUID.
GetEntityByIdAsync(String, RequestContext)	[Protocol Method] Get the Entity definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEntityByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetEntityByName(String, CancellationToken)	Get the entity definition by its name (unique).
GetEntityByName(String, RequestContext)	[Protocol Method] Get the entity definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEntityByName(String, CancellationToken) convenience overload with strongly typed models first.
GetEntityByNameAsync(String, CancellationToken)	Get the entity definition by its name (unique).
GetEntityByNameAsync(String, RequestContext)	[Protocol Method] Get the entity definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEntityByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetEnumById(String, CancellationToken)	Get the enum definition for the given GUID.
GetEnumById(String, RequestContext)	[Protocol Method] Get the enum definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEnumById(String, CancellationToken) convenience overload with strongly typed models first.
GetEnumByIdAsync(String, CancellationToken)	Get the enum definition for the given GUID.
GetEnumByIdAsync(String, RequestContext)	[Protocol Method] Get the enum definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEnumByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetEnumByName(String, CancellationToken)	Get the enum definition by its name (unique).
GetEnumByName(String, RequestContext)	[Protocol Method] Get the enum definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEnumByName(String, CancellationToken) convenience overload with strongly typed models first.
GetEnumByNameAsync(String, CancellationToken)	Get the enum definition by its name (unique).
GetEnumByNameAsync(String, RequestContext)	[Protocol Method] Get the enum definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetEnumByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetHeaders(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken)	List all type definitions returned as a list of minimal information header.
GetHeaders(Nullable<Boolean>, String, RequestContext)	[Protocol Method] List all type definitions returned as a list of minimal information header. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetHeaders(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken) convenience overload with strongly typed models first.
GetHeadersAsync(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken)	List all type definitions returned as a list of minimal information header.
GetHeadersAsync(Nullable<Boolean>, String, RequestContext)	[Protocol Method] List all type definitions returned as a list of minimal information header. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetHeadersAsync(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken) convenience overload with strongly typed models first.
GetRelationshipById(String, CancellationToken)	Get the relationship definition for the given GUID.
GetRelationshipById(String, RequestContext)	[Protocol Method] Get the relationship definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRelationshipById(String, CancellationToken) convenience overload with strongly typed models first.
GetRelationshipByIdAsync(String, CancellationToken)	Get the relationship definition for the given GUID.
GetRelationshipByIdAsync(String, RequestContext)	[Protocol Method] Get the relationship definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRelationshipByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetRelationshipByName(String, CancellationToken)	Get the relationship definition by its name (unique).
GetRelationshipByName(String, RequestContext)	[Protocol Method] Get the relationship definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRelationshipByName(String, CancellationToken) convenience overload with strongly typed models first.
GetRelationshipByNameAsync(String, CancellationToken)	Get the relationship definition by its name (unique).
GetRelationshipByNameAsync(String, RequestContext)	[Protocol Method] Get the relationship definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetRelationshipByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetStructById(String, CancellationToken)	Get the struct definition for the given GUID.
GetStructById(String, RequestContext)	[Protocol Method] Get the struct definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetStructById(String, CancellationToken) convenience overload with strongly typed models first.
GetStructByIdAsync(String, CancellationToken)	Get the struct definition for the given GUID.
GetStructByIdAsync(String, RequestContext)	[Protocol Method] Get the struct definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetStructByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetStructByName(String, CancellationToken)	Get the struct definition by its name (unique).
GetStructByName(String, RequestContext)	[Protocol Method] Get the struct definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetStructByName(String, CancellationToken) convenience overload with strongly typed models first.
GetStructByNameAsync(String, CancellationToken)	Get the struct definition by its name (unique).
GetStructByNameAsync(String, RequestContext)	[Protocol Method] Get the struct definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetStructByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTermTemplateById(String, CancellationToken)	Get the term template definition for the given GUID.
GetTermTemplateById(String, RequestContext)	[Protocol Method] Get the term template definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTermTemplateById(String, CancellationToken) convenience overload with strongly typed models first.
GetTermTemplateByIdAsync(String, CancellationToken)	Get the term template definition for the given GUID.
GetTermTemplateByIdAsync(String, RequestContext)	[Protocol Method] Get the term template definition for the given GUID. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTermTemplateByIdAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTermTemplateByName(String, CancellationToken)	Get the term template definition by its name (unique).
GetTermTemplateByName(String, RequestContext)	[Protocol Method] Get the term template definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTermTemplateByName(String, CancellationToken) convenience overload with strongly typed models first.
GetTermTemplateByNameAsync(String, CancellationToken)	Get the term template definition by its name (unique).
GetTermTemplateByNameAsync(String, RequestContext)	[Protocol Method] Get the term template definition by its name (unique). This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTermTemplateByNameAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTypeDefinition(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken)	List all type definitions in bulk.
GetTypeDefinition(Nullable<Boolean>, String, RequestContext)	[Protocol Method] List all type definitions in bulk. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTypeDefinition(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken) convenience overload with strongly typed models first.
GetTypeDefinitionAsync(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken)	List all type definitions in bulk.
GetTypeDefinitionAsync(Nullable<Boolean>, String, RequestContext)	[Protocol Method] List all type definitions in bulk. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTypeDefinitionAsync(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken) convenience overload with strongly typed models first.