public static final class QueryArtifactLineageSubgraphRequest.Builder extends GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder> implements QueryArtifactLineageSubgraphRequestOrBuilder
Request message for MetadataService.QueryArtifactLineageSubgraph.
Protobuf type google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest
Methods
public QueryArtifactLineageSubgraphRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public QueryArtifactLineageSubgraphRequest build()
Returns
public QueryArtifactLineageSubgraphRequest buildPartial()
Returns
public QueryArtifactLineageSubgraphRequest.Builder clear()
Returns
Overrides
public QueryArtifactLineageSubgraphRequest.Builder clearArtifact()
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) = { ... }
public QueryArtifactLineageSubgraphRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
public QueryArtifactLineageSubgraphRequest.Builder clearFilter()
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;
public QueryArtifactLineageSubgraphRequest.Builder clearMaxHops()
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;
public QueryArtifactLineageSubgraphRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
public QueryArtifactLineageSubgraphRequest.Builder clone()
Returns
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) = { ... }
| 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) = { ... }
public QueryArtifactLineageSubgraphRequest getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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
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;
| 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
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;
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;
| Type | Description |
| int | The maxHops.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(QueryArtifactLineageSubgraphRequest other)
Parameter
Returns
public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
public final QueryArtifactLineageSubgraphRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public QueryArtifactLineageSubgraphRequest.Builder setArtifact(String value)
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) = { ... }
| Name | Description |
| value | String
The artifact to set.
|
Returns
public QueryArtifactLineageSubgraphRequest.Builder setArtifactBytes(ByteString value)
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) = { ... }
| Name | Description |
| value | ByteString
The bytes for artifact to set.
|
Returns
public QueryArtifactLineageSubgraphRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
public QueryArtifactLineageSubgraphRequest.Builder setFilter(String value)
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;
| Name | Description |
| value | String
The filter to set.
|
Returns
public QueryArtifactLineageSubgraphRequest.Builder setFilterBytes(ByteString value)
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;
| Name | Description |
| value | ByteString
The bytes for filter to set.
|
Returns
public QueryArtifactLineageSubgraphRequest.Builder setMaxHops(int value)
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;
| Name | Description |
| value | int
The maxHops to set.
|
Returns
public QueryArtifactLineageSubgraphRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
public final QueryArtifactLineageSubgraphRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
