Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
HTTP request
GET https://{service-endpoint}/v1/{artifact}:queryArtifactLineageSubgraph
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
artifact |
Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of events that would be returned for the Context exceeds 1000. |
Query parameters
Parameters | |
---|---|
maxHops |
Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. |
filter |
Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following:
Each of the above supported filter types can be combined together using logical operators ( For example: |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of LineageSubgraph
.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the artifact
resource:
aiplatform.artifacts.get
For more information, see the IAM documentation.