TypeDefinition Class

Definition

The TypeDefinition sub-client.

public class TypeDefinition
type TypeDefinition = class
Public Class TypeDefinition
Inheritance
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.

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.

BatchDelete(AtlasTypesDef, CancellationToken)

Delete API for all types in bulk.

BatchDelete(RequestContent, RequestContext)

[Protocol Method] Delete API for all types in bulk.

BatchDeleteAsync(AtlasTypesDef, CancellationToken)

Delete API for all types in bulk.

BatchDeleteAsync(RequestContent, RequestContext)

[Protocol Method] Delete API for all types in bulk.

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.

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.

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.

GetBusinessMetadataByIdAsync(String, CancellationToken)

Get the businessMetadata definition for the given guid.

GetBusinessMetadataByIdAsync(String, RequestContext)

[Protocol Method] Get the businessMetadata definition for the given guid.

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).

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).

GetById(String, CancellationToken)

Get the type definition for the given GUID.

GetById(String, RequestContext)

[Protocol Method] Get the type definition for the given GUID.

GetByIdAsync(String, CancellationToken)

Get the type definition for the given GUID.

GetByIdAsync(String, RequestContext)

[Protocol Method] Get the type definition for the given GUID.

GetByName(String, CancellationToken)

Get the type definition by its name (unique).

GetByName(String, RequestContext)

[Protocol Method] Get the type definition by its name (unique).

GetByNameAsync(String, CancellationToken)

Get the type definition by its name (unique).

GetByNameAsync(String, RequestContext)

[Protocol Method] Get the type definition by its name (unique).

GetClassificationById(String, CancellationToken)

Get the classification definition for the given GUID.

GetClassificationById(String, RequestContext)

[Protocol Method] Get the classification definition for the given GUID.

GetClassificationByIdAsync(String, CancellationToken)

Get the classification definition for the given GUID.

GetClassificationByIdAsync(String, RequestContext)

[Protocol Method] Get the classification definition for the given GUID.

GetClassificationByName(String, CancellationToken)

Get the classification definition by its name (unique).

GetClassificationByName(String, RequestContext)

[Protocol Method] Get the classification definition by its name (unique).

GetClassificationByNameAsync(String, CancellationToken)

Get the classification definition by its name (unique).

GetClassificationByNameAsync(String, RequestContext)

[Protocol Method] Get the classification definition by its name (unique).

GetEntityById(String, CancellationToken)

Get the Entity definition for the given GUID.

GetEntityById(String, RequestContext)

[Protocol Method] Get the Entity definition for the given GUID.

GetEntityByIdAsync(String, CancellationToken)

Get the Entity definition for the given GUID.

GetEntityByIdAsync(String, RequestContext)

[Protocol Method] Get the Entity definition for the given GUID.

GetEntityByName(String, CancellationToken)

Get the entity definition by its name (unique).

GetEntityByName(String, RequestContext)

[Protocol Method] Get the entity definition by its name (unique).

GetEntityByNameAsync(String, CancellationToken)

Get the entity definition by its name (unique).

GetEntityByNameAsync(String, RequestContext)

[Protocol Method] Get the entity definition by its name (unique).

GetEnumById(String, CancellationToken)

Get the enum definition for the given GUID.

GetEnumById(String, RequestContext)

[Protocol Method] Get the enum definition for the given GUID.

GetEnumByIdAsync(String, CancellationToken)

Get the enum definition for the given GUID.

GetEnumByIdAsync(String, RequestContext)

[Protocol Method] Get the enum definition for the given GUID.

GetEnumByName(String, CancellationToken)

Get the enum definition by its name (unique).

GetEnumByName(String, RequestContext)

[Protocol Method] Get the enum definition by its name (unique).

GetEnumByNameAsync(String, CancellationToken)

Get the enum definition by its name (unique).

GetEnumByNameAsync(String, RequestContext)

[Protocol Method] Get the enum definition by its name (unique).

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.

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.

GetRelationshipById(String, CancellationToken)

Get the relationship definition for the given GUID.

GetRelationshipById(String, RequestContext)

[Protocol Method] Get the relationship definition for the given GUID.

GetRelationshipByIdAsync(String, CancellationToken)

Get the relationship definition for the given GUID.

GetRelationshipByIdAsync(String, RequestContext)

[Protocol Method] Get the relationship definition for the given GUID.

GetRelationshipByName(String, CancellationToken)

Get the relationship definition by its name (unique).

GetRelationshipByName(String, RequestContext)

[Protocol Method] Get the relationship definition by its name (unique).

GetRelationshipByNameAsync(String, CancellationToken)

Get the relationship definition by its name (unique).

GetRelationshipByNameAsync(String, RequestContext)

[Protocol Method] Get the relationship definition by its name (unique).

GetStructById(String, CancellationToken)

Get the struct definition for the given GUID.

GetStructById(String, RequestContext)

[Protocol Method] Get the struct definition for the given GUID.

GetStructByIdAsync(String, CancellationToken)

Get the struct definition for the given GUID.

GetStructByIdAsync(String, RequestContext)

[Protocol Method] Get the struct definition for the given GUID.

GetStructByName(String, CancellationToken)

Get the struct definition by its name (unique).

GetStructByName(String, RequestContext)

[Protocol Method] Get the struct definition by its name (unique).

GetStructByNameAsync(String, CancellationToken)

Get the struct definition by its name (unique).

GetStructByNameAsync(String, RequestContext)

[Protocol Method] Get the struct definition by its name (unique).

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.

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.

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).

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).

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.

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.

Applies to