public final class QueryArtifactLineageSubgraphRequest extends GeneratedMessageV3 implements QueryArtifactLineageSubgraphRequestOrBuilder
Request message for
MetadataService.QueryArtifactLineageSubgraph.
Protobuf type google.cloud.aiplatform.v1beta1.QueryArtifactLineageSubgraphRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
public static final int ARTIFACT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int MAX_HOPS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static QueryArtifactLineageSubgraphRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static QueryArtifactLineageSubgraphRequest.Builder newBuilder()
public static QueryArtifactLineageSubgraphRequest.Builder newBuilder(QueryArtifactLineageSubgraphRequest prototype)
public static QueryArtifactLineageSubgraphRequest parseDelimitedFrom(InputStream input)
public static QueryArtifactLineageSubgraphRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static QueryArtifactLineageSubgraphRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteString data)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(CodedInputStream input)
public static QueryArtifactLineageSubgraphRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(InputStream input)
public static QueryArtifactLineageSubgraphRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteBuffer data)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<QueryArtifactLineageSubgraphRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public 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 |
|---|
| Type | Description |
String | The artifact.
|
public 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 |
|---|
| Type | Description |
ByteString | The bytes for artifact.
|
public QueryArtifactLineageSubgraphRequest getDefaultInstanceForType()
public 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
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.
string filter = 3;
| Returns |
|---|
| Type | Description |
String | The filter.
|
public 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
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.
string filter = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
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 |
|---|
| Type | Description |
int | The maxHops.
|
public Parser<QueryArtifactLineageSubgraphRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public QueryArtifactLineageSubgraphRequest.Builder newBuilderForType()
protected QueryArtifactLineageSubgraphRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public QueryArtifactLineageSubgraphRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
