TypeDefinition.GetHeaders Method

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Overloads

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

GetHeaders(Nullable<Boolean>, Nullable<TypeCategory>, CancellationToken)

Source:

TypeDefinition.cs

List all type definitions returned as a list of minimal information header.

public virtual Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.Purview.DataMap.AtlasTypeDefHeader>> GetHeaders (bool? includeTermTemplate = default, Azure.Analytics.Purview.DataMap.TypeCategory? type = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetHeaders : Nullable<bool> * Nullable<Azure.Analytics.Purview.DataMap.TypeCategory> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.Purview.DataMap.AtlasTypeDefHeader>>
override this.GetHeaders : Nullable<bool> * Nullable<Azure.Analytics.Purview.DataMap.TypeCategory> * System.Threading.CancellationToken -> Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Analytics.Purview.DataMap.AtlasTypeDefHeader>>

Public Overridable Function GetHeaders (Optional includeTermTemplate As Nullable(Of Boolean) = Nothing, Optional type As Nullable(Of TypeCategory) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of IReadOnlyList(Of AtlasTypeDefHeader))

Parameters

includeTermTemplate

Nullable<Boolean>

Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template

type

Nullable<TypeCategory>

Typedef name as search filter when get typedefs.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<IReadOnlyList<AtlasTypeDefHeader>>

Examples

This sample shows how to call GetHeaders.

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

Response<IReadOnlyList<AtlasTypeDefHeader>> response = client.GetHeaders();

This sample shows how to call GetHeaders with all parameters.

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

Response<IReadOnlyList<AtlasTypeDefHeader>> response = client.GetHeaders(includeTermTemplate: true, type: TypeCategory.Primitive);

GetHeaders(Nullable<Boolean>, String, RequestContext)

Source:

TypeDefinition.cs

[Protocol Method] List all type definitions returned as a list of minimal information header.

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

public virtual Azure.Response GetHeaders (bool? includeTermTemplate, string type, Azure.RequestContext context);

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

Public Overridable Function GetHeaders (includeTermTemplate As Nullable(Of Boolean), type As String, context As RequestContext) As Response

Parameters

includeTermTemplate

Nullable<Boolean>

Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template

type

String

Typedef name as search filter when get typedefs. Allowed values: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE".

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 GetHeaders and parse the result.

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

Response response = client.GetHeaders(null, null, null);

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

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

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

Response response = client.GetHeaders(true, "PRIMITIVE", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result[0].GetProperty("category").ToString());
Console.WriteLine(result[0].GetProperty("guid").ToString());
Console.WriteLine(result[0].GetProperty("name").ToString());