Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class QueryArtifactLineageSubgraphRequest.
Request message for MetadataService.QueryArtifactLineageSubgraph.
Generated from protobuf message google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ artifact |
string
Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: |
↳ max_hops |
int
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: |
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.
| Returns | |
|---|---|
| Type | Description |
string | |
setArtifact
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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.
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxHops
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
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_timeandupdate_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.0In 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.0Each 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.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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_timeandupdate_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.0In 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.0Each 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
artifact |
string
Required. The resource name of the Artifact whose Lineage needs to be
retrieved as a LineageSubgraph. Format:
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. Please see Google\Cloud\AIPlatform\V1\MetadataServiceClient::artifactName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\QueryArtifactLineageSubgraphRequest | |