90 строки
18 KiB
YAML
90 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.analytics.purview.catalog.LineageClient"
|
|
fullName: "com.azure.analytics.purview.catalog.LineageClient"
|
|
name: "LineageClient"
|
|
nameWithType: "LineageClient"
|
|
summary: "Initializes a new instance of the synchronous Purview<wbr>Catalog<wbr>Client type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **LineageClient**"
|
|
methods:
|
|
- uid: "com.azure.analytics.purview.catalog.LineageClient.getLineageByUniqueAttributeWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.LineageClient.getLineageByUniqueAttributeWithResponse(String typeName, String direction, RequestOptions requestOptions)"
|
|
name: "getLineageByUniqueAttributeWithResponse(String typeName, String direction, RequestOptions requestOptions)"
|
|
nameWithType: "LineageClient.getLineageByUniqueAttributeWithResponse(String typeName, String direction, RequestOptions requestOptions)"
|
|
summary: "Returns lineage info about entity."
|
|
parameters:
|
|
- description: "The name of the type."
|
|
name: "typeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: BOTH, INPUT,\n OUTPUT."
|
|
name: "direction"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getLineageByUniqueAttributeWithResponse(String typeName, String direction, RequestOptions requestOptions)"
|
|
desc: "Returns lineage info about entity.\n\nIn addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format\n\nattr:\\[attrName\\]=\\[attrValue\\]\n\nNOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.\n\n**Query Parameters**\n\n | ----------------- | ------- | -------- | ------------------------------------------------- |\n | Name | Type | Required | Description |\n | depth | Integer | No | The number of hops for lineage. |\n | width | Integer | No | The number of max expanding width in lineage. |\n | includeParent | Boolean | No | True to include the parent chain in the response. |\n | getDerivedLineage | Boolean | No | True to include derived lineage in the response |\n\n**Response Body Schema**\n\n```java\n{\n baseEntityGuid: String\n guidEntityMap: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n }\n widthCounts: {\n String: {\n String: Object\n }\n }\n lineageDepth: Integer\n lineageWidth: Integer\n includeParent: Boolean\n childrenCount: Integer\n lineageDirection: String(INPUT/OUTPUT/BOTH)\n parentRelations: [\n {\n childEntityId: String\n relationshipId: String\n parentEntityId: String\n }\n ]\n relations: [\n {\n fromEntityId: String\n relationshipId: String\n toEntityId: String\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "atlasLineageInfo along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.LineageClient.getLineageGraphWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.LineageClient.getLineageGraphWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
name: "getLineageGraphWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
nameWithType: "LineageClient.getLineageGraphWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
summary: "Get lineage info of the entity specified by GUID."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: BOTH, INPUT,\n OUTPUT."
|
|
name: "direction"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> getLineageGraphWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
desc: "Get lineage info of the entity specified by GUID.\n\n**Query Parameters**\n\n | ----------------- | ------- | -------- | ------------------------------------------------- |\n | Name | Type | Required | Description |\n | depth | Integer | No | The number of hops for lineage. |\n | width | Integer | No | The number of max expanding width in lineage. |\n | includeParent | Boolean | No | True to include the parent chain in the response. |\n | getDerivedLineage | Boolean | No | True to include derived lineage in the response |\n\n**Response Body Schema**\n\n```java\n{\n baseEntityGuid: String\n guidEntityMap: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n }\n widthCounts: {\n String: {\n String: Object\n }\n }\n lineageDepth: Integer\n lineageWidth: Integer\n includeParent: Boolean\n childrenCount: Integer\n lineageDirection: String(INPUT/OUTPUT/BOTH)\n parentRelations: [\n {\n childEntityId: String\n relationshipId: String\n parentEntityId: String\n }\n ]\n relations: [\n {\n fromEntityId: String\n relationshipId: String\n toEntityId: String\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "lineage info of the entity specified by GUID along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.analytics.purview.catalog.LineageClient.nextPageLineageWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.analytics.purview.catalog.LineageClient.nextPageLineageWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
name: "nextPageLineageWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
nameWithType: "LineageClient.nextPageLineageWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
summary: "Return immediate next page lineage info about entity with pagination."
|
|
parameters:
|
|
- description: "The globally unique identifier of the entity."
|
|
name: "guid"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The direction of the lineage, which could be INPUT, OUTPUT or BOTH. Allowed values: BOTH, INPUT,\n OUTPUT."
|
|
name: "direction"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BinaryData> nextPageLineageWithResponse(String guid, String direction, RequestOptions requestOptions)"
|
|
desc: "Return immediate next page lineage info about entity with pagination.\n\n**Query Parameters**\n\n | ----------------- | ------- | -------- | ----------------------------------------------- |\n | Name | Type | Required | Description |\n | getDerivedLineage | Boolean | No | True to include derived lineage in the response |\n | offset | Integer | No | The offset for pagination purpose. |\n | limit | Integer | No | The page size - by default there is no paging. |\n\n**Response Body Schema**\n\n```java\n{\n baseEntityGuid: String\n guidEntityMap: {\n String: {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n classificationNames: [\n String\n ]\n classifications: [\n {\n attributes: {\n String: Object\n }\n typeName: String\n lastModifiedTS: String\n entityGuid: String\n entityStatus: String(ACTIVE/DELETED)\n removePropagationsOnEntityDelete: Boolean\n validityPeriods: [\n {\n endTime: String\n startTime: String\n timeZone: String\n }\n ]\n source: String\n sourceDetails: {\n String: Object\n }\n }\n ]\n displayText: String\n guid: String\n isIncomplete: Boolean\n labels: [\n String\n ]\n meaningNames: [\n String\n ]\n meanings: [\n {\n confidence: Integer\n createdBy: String\n description: String\n displayText: String\n expression: String\n relationGuid: String\n source: String\n status: String(DISCOVERED/PROPOSED/IMPORTED/VALIDATED/DEPRECATED/OBSOLETE/OTHER)\n steward: String\n termGuid: String\n }\n ]\n status: String(ACTIVE/DELETED)\n }\n }\n widthCounts: {\n String: {\n String: Object\n }\n }\n lineageDepth: Integer\n lineageWidth: Integer\n includeParent: Boolean\n childrenCount: Integer\n lineageDirection: String(INPUT/OUTPUT/BOTH)\n parentRelations: [\n {\n childEntityId: String\n relationshipId: String\n parentEntityId: String\n }\n ]\n relations: [\n {\n fromEntityId: String\n relationshipId: String\n toEntityId: String\n }\n ]\n }\n```"
|
|
returns:
|
|
description: "atlasLineageInfo along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the synchronous PurviewCatalogClient type."
|
|
metadata: {}
|
|
package: "com.azure.analytics.purview.catalog"
|
|
artifact: com.azure:azure-analytics-purview-catalog:1.0.0-beta.4
|