Glossary.BatchGet Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

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

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)

Source:

Glossary.cs

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

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

public virtual Azure.Response BatchGet (int? limit, int? offset, string sort, bool? ignoreTermsAndCategories, Azure.RequestContext context);

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

Public Overridable Function BatchGet (limit As Nullable(Of Integer), offset As Nullable(Of Integer), sort As String, ignoreTermsAndCategories As Nullable(Of Boolean), context As RequestContext) As Response

Parameters

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.

ignoreTermsAndCategories

Nullable<Boolean>

Whether ignore terms and categories.

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call BatchGet 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.BatchGet(null, null, null, null, null);

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

This sample shows how to call BatchGet 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(apiVersion: "2023-09-01");

Response response = client.BatchGet(1234, 1234, "<sort>", true, 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("categories")[0].GetProperty("categoryGuid").ToString());
Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("description").ToString());
Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("displayText").ToString());
Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("parentCategoryGuid").ToString());
Console.WriteLine(result[0].GetProperty("categories")[0].GetProperty("relationGuid").ToString());
Console.WriteLine(result[0].GetProperty("language").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());
Console.WriteLine(result[0].GetProperty("usage").ToString());

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

Source:

Glossary.cs

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

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

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

Public Overridable Function BatchGet (Optional limit As Nullable(Of Integer) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional sort As String = Nothing, Optional ignoreTermsAndCategories As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of AtlasGlossary))

Parameters

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.

ignoreTermsAndCategories

Nullable<Boolean>

Whether ignore terms and categories.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<AtlasGlossary>>

Examples

This sample shows how to call BatchGet.

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

Response<IReadOnlyList<AtlasGlossary>> response = client.BatchGet();

This sample shows how to call BatchGet with all parameters.

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

Response<IReadOnlyList<AtlasGlossary>> response = client.BatchGet(limit: 1234, offset: 1234, sort: "<sort>", ignoreTermsAndCategories: true);