Compartir a través de


Glossary Class

Definition

The Glossary sub-client.

public class Glossary
type Glossary = class
Public Class Glossary
Inheritance
Glossary

Constructors

Glossary()

Initializes a new instance of Glossary for mocking.

Properties

Pipeline

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

Methods

AssignTermToEntities(String, IEnumerable<AtlasRelatedObjectId>, CancellationToken)

Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.

Entities Create Or Update operation is an alternative to assign a term to multiple entities.

AssignTermToEntities(String, RequestContent, RequestContext)

[Protocol Method] Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.

Entities Create Or Update operation is an alternative to assign a term to multiple entities.

AssignTermToEntitiesAsync(String, IEnumerable<AtlasRelatedObjectId>, CancellationToken)

Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.

Entities Create Or Update operation is an alternative to assign a term to multiple entities.

AssignTermToEntitiesAsync(String, RequestContent, RequestContext)

[Protocol Method] Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls.

Entities Create Or Update operation is an alternative to assign a term to multiple entities.

BatchGet(Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, CancellationToken)

Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using

'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and

'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

BatchGet(Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, RequestContext)

[Protocol Method] Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using

'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and

'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

BatchGetAsync(Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, CancellationToken)

Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using

'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and

'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

BatchGetAsync(Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, RequestContext)

[Protocol Method] Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using

'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and

'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

Create(AtlasGlossary, CancellationToken)

Create a glossary.

Create(RequestContent, RequestContext)

[Protocol Method] Create a glossary.

CreateAsync(AtlasGlossary, CancellationToken)

Create a glossary.

CreateAsync(RequestContent, RequestContext)

[Protocol Method] Create a glossary.

CreateCategories(IEnumerable<AtlasGlossaryCategory>, CancellationToken)

Create glossary category in bulk.

CreateCategories(RequestContent, RequestContext)

[Protocol Method] Create glossary category in bulk.

CreateCategoriesAsync(IEnumerable<AtlasGlossaryCategory>, CancellationToken)

Create glossary category in bulk.

CreateCategoriesAsync(RequestContent, RequestContext)

[Protocol Method] Create glossary category in bulk.

CreateCategory(AtlasGlossaryCategory, CancellationToken)

Create a glossary category.

CreateCategory(RequestContent, RequestContext)

[Protocol Method] Create a glossary category.

CreateCategoryAsync(AtlasGlossaryCategory, CancellationToken)

Create a glossary category.

CreateCategoryAsync(RequestContent, RequestContext)

[Protocol Method] Create a glossary category.

CreateTerm(AtlasGlossaryTerm, Nullable<Boolean>, CancellationToken)

Create a glossary term.

CreateTerm(RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Create a glossary term.

CreateTermAsync(AtlasGlossaryTerm, Nullable<Boolean>, CancellationToken)

Create a glossary term.

CreateTermAsync(RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Create a glossary term.

CreateTerms(IEnumerable<AtlasGlossaryTerm>, Nullable<Boolean>, CancellationToken)

Create glossary terms in bulk.

CreateTerms(RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Create glossary terms in bulk.

CreateTermsAsync(IEnumerable<AtlasGlossaryTerm>, Nullable<Boolean>, CancellationToken)

Create glossary terms in bulk.

CreateTermsAsync(RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Create glossary terms in bulk.

Delete(String, RequestContext)

[Protocol Method] Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteAsync(String, RequestContext)

[Protocol Method] Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteCategory(String, RequestContext)

[Protocol Method] Delete a glossary category.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteCategoryAsync(String, RequestContext)

[Protocol Method] Delete a glossary category.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTerm(String, RequestContext)

[Protocol Method] Delete a glossary term.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTermAssignmentFromEntities(String, IEnumerable<AtlasRelatedObjectId>, CancellationToken)

Delete the term assignment for the given list of related objects.

DeleteTermAssignmentFromEntities(String, RequestContent, RequestContext)

[Protocol Method] Delete the term assignment for the given list of related objects.

DeleteTermAssignmentFromEntitiesAsync(String, IEnumerable<AtlasRelatedObjectId>, CancellationToken)

Delete the term assignment for the given list of related objects.

DeleteTermAssignmentFromEntitiesAsync(String, RequestContent, RequestContext)

[Protocol Method] Delete the term assignment for the given list of related objects.

DeleteTermAsync(String, RequestContext)

[Protocol Method] Delete a glossary term.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetCategories(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategories(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategoriesAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategoriesAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategoriesHeaders(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategoriesHeaders(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategoriesHeadersAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategoriesHeadersAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetCategory(String, CancellationToken)

Get specific glossary category by its GUID.

GetCategory(String, RequestContext)

[Protocol Method] Get specific glossary category by its GUID.

GetCategoryAsync(String, CancellationToken)

Get specific glossary category by its GUID.

GetCategoryAsync(String, RequestContext)

[Protocol Method] Get specific glossary category by its GUID.

GetCategoryTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all terms associated with the specific category.

GetCategoryTerms(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all terms associated with the specific category.

GetCategoryTermsAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all terms associated with the specific category.

GetCategoryTermsAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all terms associated with the specific category.

GetDetailed(String, CancellationToken)

Get a specific glossary with detailed information. This API is not recommend.

Recommend to fetch terms/categories details separately using

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

GetDetailed(String, RequestContext)

[Protocol Method] Get a specific glossary with detailed information. This API is not recommend.

Recommend to fetch terms/categories details separately using

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

GetDetailedAsync(String, CancellationToken)

Get a specific glossary with detailed information. This API is not recommend.

Recommend to fetch terms/categories details separately using

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

GetDetailedAsync(String, RequestContext)

[Protocol Method] Get a specific glossary with detailed information. This API is not recommend.

Recommend to fetch terms/categories details separately using

GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and

GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

GetEntitiesAssignedWithTerm(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.

GetEntitiesAssignedWithTerm(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.

GetEntitiesAssignedWithTermAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.

GetEntitiesAssignedWithTermAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.

GetGlossary(String, CancellationToken)

Get a specific Glossary by its GUID.

GetGlossary(String, RequestContext)

[Protocol Method] Get a specific Glossary by its GUID.

GetGlossaryAsync(String, CancellationToken)

Get a specific Glossary by its GUID.

GetGlossaryAsync(String, RequestContext)

[Protocol Method] Get a specific Glossary by its GUID.

GetRelatedCategories(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedCategories(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedCategoriesAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedCategoriesAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedTerms(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedTermsAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetRelatedTermsAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

GetTerm(String, CancellationToken)

Get a specific glossary term by its GUID.

GetTerm(String, RequestContext)

[Protocol Method] Get a specific glossary term by its GUID.

GetTermAsync(String, CancellationToken)

Get a specific glossary term by its GUID.

GetTermAsync(String, RequestContext)

[Protocol Method] Get a specific glossary term by its GUID.

GetTermHeaders(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTermHeaders(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTermHeadersAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTermHeadersAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTerms(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTerms(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTermsAsync(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken)

Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GetTermsAsync(String, Nullable<Int32>, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.

PartialUpdate(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken)

Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

So far we only supports partial updating shortDescription, longDescription, language and usage for glossary.

Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.

PartialUpdate(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

So far we only supports partial updating shortDescription, longDescription, language and usage for glossary.

Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.

PartialUpdateAsync(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken)

Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

So far we only supports partial updating shortDescription, longDescription, language and usage for glossary.

Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.

PartialUpdateAsync(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

So far we only supports partial updating shortDescription, longDescription, language and usage for glossary.

Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.

PartialUpdateCategory(String, IDictionary<String,String>, CancellationToken)

Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.

PartialUpdateCategory(String, RequestContent, RequestContext)

[Protocol Method] Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.

PartialUpdateCategoryAsync(String, IDictionary<String,String>, CancellationToken)

Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.

PartialUpdateCategoryAsync(String, RequestContent, RequestContext)

[Protocol Method] Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.

PartialUpdateTerm(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken)

Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.

PartialUpdateTerm(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.

PartialUpdateTermAsync(String, IDictionary<String,String>, Nullable<Boolean>, CancellationToken)

Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.

PartialUpdateTermAsync(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.

Update(String, AtlasGlossary, Nullable<Boolean>, CancellationToken)

Update the given glossary.

Update(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the given glossary.

UpdateAsync(String, AtlasGlossary, Nullable<Boolean>, CancellationToken)

Update the given glossary.

UpdateAsync(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the given glossary.

UpdateCategory(String, AtlasGlossaryCategory, CancellationToken)

Update the given glossary category by its GUID.

UpdateCategory(String, RequestContent, RequestContext)

[Protocol Method] Update the given glossary category by its GUID.

UpdateCategoryAsync(String, AtlasGlossaryCategory, CancellationToken)

Update the given glossary category by its GUID.

UpdateCategoryAsync(String, RequestContent, RequestContext)

[Protocol Method] Update the given glossary category by its GUID.

UpdateTerm(String, AtlasGlossaryTerm, Nullable<Boolean>, CancellationToken)

Update the given glossary term by its GUID.

UpdateTerm(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the given glossary term by its GUID.

UpdateTermAsync(String, AtlasGlossaryTerm, Nullable<Boolean>, CancellationToken)

Update the given glossary term by its GUID.

UpdateTermAsync(String, RequestContent, Nullable<Boolean>, RequestContext)

[Protocol Method] Update the given glossary term by its GUID.

Applies to