- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public final class QueryArtifactLineageSubgraphRequest extends GeneratedMessageV3 implements QueryArtifactLineageSubgraphRequestOrBuilder
Request message for MetadataService.QueryArtifactLineageSubgraph.
Protobuf type google.cloud.aiplatform.v1beta1.QueryArtifactLineageSubgraphRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > QueryArtifactLineageSubgraphRequestImplements
QueryArtifactLineageSubgraphRequestOrBuilderStatic Fields
ARTIFACT_FIELD_NUMBER
public static final int ARTIFACT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
MAX_HOPS_FIELD_NUMBER
public static final int MAX_HOPS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static QueryArtifactLineageSubgraphRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static QueryArtifactLineageSubgraphRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest.Builder |
newBuilder(QueryArtifactLineageSubgraphRequest prototype)
public static QueryArtifactLineageSubgraphRequest.Builder newBuilder(QueryArtifactLineageSubgraphRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype |
QueryArtifactLineageSubgraphRequest |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest.Builder |
parseDelimitedFrom(InputStream input)
public static QueryArtifactLineageSubgraphRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static QueryArtifactLineageSubgraphRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static QueryArtifactLineageSubgraphRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static QueryArtifactLineageSubgraphRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryArtifactLineageSubgraphRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<QueryArtifactLineageSubgraphRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<QueryArtifactLineageSubgraphRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getArtifact()
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. |
getArtifactBytes()
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. |
getDefaultInstanceForType()
public QueryArtifactLineageSubgraphRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest |
getFilter()
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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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. |
getFilterBytes()
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
, andupdate_time
. Time fields, such ascreate_time
andupdate_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. |
getMaxHops()
public 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 | |
---|---|
Type | Description |
int |
The maxHops. |
getParserForType()
public Parser<QueryArtifactLineageSubgraphRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<QueryArtifactLineageSubgraphRequest> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public QueryArtifactLineageSubgraphRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryArtifactLineageSubgraphRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public QueryArtifactLineageSubgraphRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
QueryArtifactLineageSubgraphRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |