Method: projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph

Stay organized with collections Save and categorize content based on your preferences.

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

string

Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}

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

integer

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

string

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:

  • Attribute filtering: For example: displayName = "test" Supported fields include: name, displayName, uri, state, schemaTitle, createTime, and updateTime. Time fields, such as createTime and updateTime, require values specified in RFC-3339 format. For example: createTime = "2020-11-19T11:30:00-04:00"
  • Metadata field: To filter on metadata fields use traversal operation as follows: metadata.<fieldName>.<type_value>. For example: metadata.field_1.number_value = 10.0

Each of the above supported filter types can be combined together using logical operators (AND & OR). Maximum nested expression depth allowed is 5.

For example: displayName = "test" AND metadata.field1.bool_value = true.

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.