Glossary.GetCategories Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

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. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetCategories(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) convenience overload with strongly typed models first.

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)

Source:

Glossary.cs

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

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetCategories(String, Nullable<Int32>, Nullable<Int32>, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetCategories (string glossaryId, int? limit, int? offset, string sort, Azure.RequestContext context);

abstract member GetCategories : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response
override this.GetCategories : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetCategories (glossaryId As String, limit As Nullable(Of Integer), offset As Nullable(Of Integer), sort As String, context As RequestContext) As Response

Parameters

glossaryId

String

The globally unique identifier for glossary.

limit

Nullable<Int32>

The page size - by default there is no paging.

offset

Nullable<Int32>

The offset for pagination purpose.

sort

String

The sort order, ASC (default) or DESC.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

glossaryId is null.

ArgumentException

glossaryId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetCategories and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response response = client.GetCategories("<glossaryId>", null, null, null, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result[0].ToString());

This sample shows how to call GetCategories with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response response = client.GetCategories("<glossaryId>", 1234, 1234, "<sort>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result[0].GetProperty("guid").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("attributes").GetProperty("<key>").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("typeName").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityGuid").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("entityStatus").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("removePropagationsOnEntityDelete").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("endTime").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("startTime").ToString());
Console.WriteLine(result[0].GetProperty("classifications")[0].GetProperty("validityPeriods")[0].GetProperty("timeZone").ToString());
Console.WriteLine(result[0].GetProperty("longDescription").ToString());
Console.WriteLine(result[0].GetProperty("name").ToString());
Console.WriteLine(result[0].GetProperty("qualifiedName").ToString());
Console.WriteLine(result[0].GetProperty("shortDescription").ToString());
Console.WriteLine(result[0].GetProperty("lastModifiedTS").ToString());
Console.WriteLine(result[0].GetProperty("createTime").ToString());
Console.WriteLine(result[0].GetProperty("createdBy").ToString());
Console.WriteLine(result[0].GetProperty("updateTime").ToString());
Console.WriteLine(result[0].GetProperty("updatedBy").ToString());
Console.WriteLine(result[0].GetProperty("anchor").GetProperty("displayText").ToString());
Console.WriteLine(result[0].GetProperty("anchor").GetProperty("glossaryGuid").ToString());
Console.WriteLine(result[0].GetProperty("anchor").GetProperty("relationGuid").ToString());
Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("categoryGuid").ToString());
Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("description").ToString());
Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("displayText").ToString());
Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result[0].GetProperty("childrenCategories")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("categoryGuid").ToString());
Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("description").ToString());
Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("displayText").ToString());
Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result[0].GetProperty("parentCategory").GetProperty("relationGuid").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("description").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("displayText").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("expression").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("status").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("steward").ToString());
Console.WriteLine(result[0].GetProperty("terms")[0].GetProperty("termGuid").ToString());

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

Source:

Glossary.cs

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

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory>> GetCategories (string glossaryId, int? limit = default, int? offset = default, string sort = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCategories : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory>>
override this.GetCategories : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.Purview.DataMap.AtlasGlossaryCategory>>

Public Overridable Function GetCategories (glossaryId As String, Optional limit As Nullable(Of Integer) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional sort As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of AtlasGlossaryCategory))

Parameters

glossaryId

String

The globally unique identifier for glossary.

limit

Nullable<Int32>

The page size - by default there is no paging.

offset

Nullable<Int32>

The offset for pagination purpose.

sort

String

The sort order, ASC (default) or DESC.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<AtlasGlossaryCategory>>

Exceptions

ArgumentNullException

glossaryId is null.

ArgumentException

glossaryId is an empty string, and was expected to be non-empty.

Examples

This sample shows how to call GetCategories.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response<IReadOnlyList<AtlasGlossaryCategory>> response = client.GetCategories("<glossaryId>");

This sample shows how to call GetCategories with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response<IReadOnlyList<AtlasGlossaryCategory>> response = client.GetCategories("<glossaryId>", limit: 1234, offset: 1234, sort: "<sort>");