Class ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.QueryArtifactLineageSubgraphRequest

Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudAiplatformV1beta1LineageSubgraph>
AiplatformBaseServiceRequest<GoogleCloudAiplatformV1beta1LineageSubgraph>
ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.QueryArtifactLineageSubgraphRequest
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.MetadataStoresResource.ArtifactsResource.QueryArtifactLineageSubgraphRequest : AiplatformBaseServiceRequest<GoogleCloudAiplatformV1beta1LineageSubgraph>, IClientServiceRequest<GoogleCloudAiplatformV1beta1LineageSubgraph>, IClientServiceRequest

Constructors

QueryArtifactLineageSubgraphRequest(IClientService, string)

Constructs a new QueryArtifactLineageSubgraph request.

Declaration
public QueryArtifactLineageSubgraphRequest(IClientService service, string artifact)
Parameters
Type Name Description
IClientService service
string artifact

Properties

Artifact

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.

Declaration
[RequestParameter("artifact", RequestParameterType.Path)]
public virtual string Artifact { get; }
Property Value
Type Description
string

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: * Attribute filtering: For example: display_name = "test" Supported fields include: name, display_name, uri, state, schema_title, create_time, and update_time. Time fields, such as create_time and update_time, require values specified in RFC-3339 format. For example: create_time = "2020-11-19T11:30:00-04:00" * Metadata field: To filter on metadata fields use traversal operation as follows: metadata... For example: metadata.field_1.number_value = 10.0 In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: metadata."field:1".number_value = 10.0 Each of the above supported filter types can be combined together using logical operators (AND &amp; OR). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

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.

Declaration
[RequestParameter("maxHops", RequestParameterType.Query)]
public virtual int? MaxHops { get; set; }
Property Value
Type Description
int?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes QueryArtifactLineageSubgraph parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements