Glossary.GetRelatedCategoriesAsync Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

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

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

Source:

Glossary.cs

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.

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyDictionary<string,System.Collections.Generic.IList<Azure.Analytics.Purview.DataMap.AtlasRelatedCategoryHeader>>>> GetRelatedCategoriesAsync (string categoryId, int? limit = default, int? offset = default, string sort = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRelatedCategoriesAsync : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IList<Azure.Analytics.Purview.DataMap.AtlasRelatedCategoryHeader>>>>
override this.GetRelatedCategoriesAsync : string * Nullable<int> * Nullable<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyDictionary<string, System.Collections.Generic.IList<Azure.Analytics.Purview.DataMap.AtlasRelatedCategoryHeader>>>>

Public Overridable Function GetRelatedCategoriesAsync (categoryId 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 Task(Of Response(Of IReadOnlyDictionary(Of String, IList(Of AtlasRelatedCategoryHeader))))

Parameters

categoryId

String

The globally unique identifier of the category.

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

Task<Response<IReadOnlyDictionary<String,IList<AtlasRelatedCategoryHeader>>>>

Exceptions

ArgumentNullException

categoryId is null.

ArgumentException

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

Examples

This sample shows how to call GetRelatedCategoriesAsync.

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

Response<IReadOnlyDictionary<string, IList<AtlasRelatedCategoryHeader>>> response = await client.GetRelatedCategoriesAsync("<categoryId>");

This sample shows how to call GetRelatedCategoriesAsync with all parameters.

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

Response<IReadOnlyDictionary<string, IList<AtlasRelatedCategoryHeader>>> response = await client.GetRelatedCategoriesAsync("<categoryId>", limit: 1234, offset: 1234, sort: "<sort>");

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

Source:

Glossary.cs

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

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetRelatedCategoriesAsync (string categoryId, int? limit, int? offset, string sort, Azure.RequestContext context);

abstract member GetRelatedCategoriesAsync : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetRelatedCategoriesAsync : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetRelatedCategoriesAsync (categoryId As String, limit As Nullable(Of Integer), offset As Nullable(Of Integer), sort As String, context As RequestContext) As Task(Of Response)

Parameters

categoryId

String

The globally unique identifier of the category.

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

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

categoryId is null.

ArgumentException

categoryId 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 GetRelatedCategoriesAsync 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 = await client.GetRelatedCategoriesAsync("<categoryId>", null, null, null, null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("<key>")[0].ToString());

This sample shows how to call GetRelatedCategoriesAsync 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 = await client.GetRelatedCategoriesAsync("<categoryId>", 1234, 1234, "<sort>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("categoryGuid").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("displayText").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result.GetProperty("<key>")[0].GetProperty("relationGuid").ToString());