com.google.cloud.aiplatform.v1beta1

Interface QueryArtifactLineageSubgraphRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

QueryArtifactLineageSubgraphRequest, QueryArtifactLineageSubgraphRequest.Builder

public interface QueryArtifactLineageSubgraphRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getArtifact() Required.
com.google.protobuf.ByteString	getArtifactBytes() Required.
String	getFilter() Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
com.google.protobuf.ByteString	getFilterBytes() Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
int	getMaxHops() Specifies the size of the lineage graph in terms of number of hops from the specified artifact.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getArtifact

String getArtifact()

 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.
 

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The artifact.

getArtifactBytes

com.google.protobuf.ByteString getArtifactBytes()

 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.
 

string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for artifact.

getMaxHops

int getMaxHops()

 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.
 

int32 max_hops = 2;

Returns:

The maxHops.

getFilter

String getFilter()

 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`
 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`).
 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
 

string filter = 3;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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`
 Each of the above supported filter types can be combined together using
 logical operators (`AND` & `OR`).
 For example: `display_name = "test" AND metadata.field1.bool_value = true`.
 

string filter = 3;

Returns:

The bytes for filter.