PurviewTypes.GetClassificationDefByGuidAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:

PurviewTypes.cs

Get the classification definition for the given GUID.

public virtual System.Threading.Tasks.Task<Azure.Response> GetClassificationDefByGuidAsync (string guid, Azure.RequestContext context = default);

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

Public Overridable Function GetClassificationDefByGuidAsync (guid As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

guid

String

The globally unique identifier of the classification.

context

RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

guid is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              attributeDefs: [
                {
                  cardinality: "SINGLE" | "LIST" | "SET",
                  constraints: [
                    {
                      params: Dictionary<string, AnyObject>,
                      type: string
                    }
                  ],
                  defaultValue: string,
                  description: string,
                  includeInNotification: boolean,
                  isIndexable: boolean,
                  isOptional: boolean,
                  isUnique: boolean,
                  name: string,
                  options: Dictionary<string, string>,
                  typeName: string,
                  valuesMaxCount: number,
                  valuesMinCount: number
                }
              ],
              category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE",
              createTime: number,
              createdBy: string,
              dateFormatter: {
                availableLocales: [string],
                calendar: number,
                dateInstance: DateFormat,
                dateTimeInstance: DateFormat,
                instance: DateFormat,
                lenient: boolean,
                numberFormat: {
                  availableLocales: [string],
                  currency: string,
                  currencyInstance: NumberFormat,
                  groupingUsed: boolean,
                  instance: NumberFormat,
                  integerInstance: NumberFormat,
                  maximumFractionDigits: number,
                  maximumIntegerDigits: number,
                  minimumFractionDigits: number,
                  minimumIntegerDigits: number,
                  numberInstance: NumberFormat,
                  parseIntegerOnly: boolean,
                  percentInstance: NumberFormat,
                  roundingMode: "UP" | "DOWN" | "CEILING" | "FLOOR" | "HALF_UP" | "HALF_DOWN" | "HALF_EVEN" | "UNNECESSARY"
                },
                timeInstance: DateFormat,
                timeZone: {
                  dstSavings: number,
                  id: string,
                  availableIds: [string],
                  default: TimeZone,
                  displayName: string,
                  rawOffset: number
                }
              },
              description: string,
              guid: string,
              name: string,
              options: Dictionary<string, string>,
              serviceType: string,
              typeVersion: string,
              updateTime: number,
              updatedBy: string,
              version: number,
              lastModifiedTS: string,
              entityTypes: [string],
              subTypes: [string],
              superTypes: [string]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }