Struct QueryArtifactLineageSubgraphRequest 

#[non_exhaustive]
pub struct QueryArtifactLineageSubgraphRequest {
    pub artifact: String,
    pub max_hops: i32,
    pub filter: String,
    /* private fields */
}

Available on crate feature metadata-service only.

Request message for MetadataService.QueryArtifactLineageSubgraph.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

max_hops: i32

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: 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.<field_name>.<type_value>. 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 & OR). Maximum nested expression depth allowed is 5.

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

Implementations

impl QueryArtifactLineageSubgraphRequest

pub fn new() -> Self

Creates a new default instance.

pub fn set_artifact<T: Into<String>>(self, v: T) -> Self

Sets the value of artifact.

Example

let x = QueryArtifactLineageSubgraphRequest::new().set_artifact(format!("projects/{project_id}/locations/{location_id}/metadataStores/{metadata_store_id}/artifacts/{artifact_id}"));

pub fn set_max_hops<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_hops.

Example

let x = QueryArtifactLineageSubgraphRequest::new().set_max_hops(42);

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = QueryArtifactLineageSubgraphRequest::new().set_filter("example");

Trait Implementations

impl Clone for QueryArtifactLineageSubgraphRequest

fn clone(&self) -> QueryArtifactLineageSubgraphRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryArtifactLineageSubgraphRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryArtifactLineageSubgraphRequest

fn default() -> QueryArtifactLineageSubgraphRequest

Returns the “default value” for a type.

impl Message for QueryArtifactLineageSubgraphRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for QueryArtifactLineageSubgraphRequest

fn eq(&self, other: &QueryArtifactLineageSubgraphRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for QueryArtifactLineageSubgraphRequest