Class QueryArtifactLineageSubgraphRequest.Builder (3.4.1)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryArtifactLineageSubgraphRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

build()

public QueryArtifactLineageSubgraphRequest build()
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest

buildPartial()

public QueryArtifactLineageSubgraphRequest buildPartial()
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest

clear()

public QueryArtifactLineageSubgraphRequest.Builder clear()
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

clearArtifact()

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) = { ... }

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public QueryArtifactLineageSubgraphRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

clearFilter()

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;

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

clearMaxHops()

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;

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryArtifactLineageSubgraphRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

clone()

public QueryArtifactLineageSubgraphRequest.Builder clone()
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for artifact.

getDefaultInstanceForType()

public QueryArtifactLineageSubgraphRequest getDefaultInstanceForType()
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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, 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;

Returns
TypeDescription
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, 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;

Returns
TypeDescription
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
TypeDescription
int

The maxHops.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(QueryArtifactLineageSubgraphRequest other)

public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(QueryArtifactLineageSubgraphRequest other)
Parameter
NameDescription
otherQueryArtifactLineageSubgraphRequest
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryArtifactLineageSubgraphRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

setArtifact(String value)

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) = { ... }

Parameter
NameDescription
valueString

The artifact to set.

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

setArtifactBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for artifact to set.

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public QueryArtifactLineageSubgraphRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

setFilter(String value)

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;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

setMaxHops(int value)

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;

Parameter
NameDescription
valueint

The maxHops to set.

Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueryArtifactLineageSubgraphRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryArtifactLineageSubgraphRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueryArtifactLineageSubgraphRequest.Builder
Overrides