PurviewEntities.GetClassificationAsync(String, 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:

PurviewEntities.cs

List classifications for a given entity represented by a GUID.

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

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

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

Parameters

guid

String

The globally unique identifier of the entity.

classificationName

String

The name 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 or classificationName is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              attributes: Dictionary<string, AnyObject>,
              typeName: string,
              lastModifiedTS: string,
              entityGuid: string,
              entityStatus: "ACTIVE" | "DELETED",
              removePropagationsOnEntityDelete: boolean,
              validityPeriods: [
                {
                  endTime: string,
                  startTime: string,
                  timeZone: string
                }
              ],
              source: string,
              sourceDetails: Dictionary<string, AnyObject>
            }

Schema for Response Error:

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