Google Cloud Ai Platform V1 Client - Class QueryArtifactLineageSubgraphRequest (0.10.0)

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

Methods

__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: `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.
`↳ 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: `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`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`.

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.

Generated from protobuf field string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setArtifact

Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph.

Generated from protobuf field string artifact = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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.

Generated from protobuf field int32 max_hops = 2;

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.

Generated from protobuf field int32 max_hops = 2;

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, 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). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

Generated from protobuf field string filter = 3;

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, 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). Maximum nested expression depth allowed is 5. For example: display_name = "test" AND metadata.field1.bool_value = true.

Generated from protobuf field string filter = 3;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`