com.google.cloud.aiplatform.v1

Class QueryArtifactLineageSubgraphRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

com.google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest.Builder

All Implemented Interfaces:

QueryArtifactLineageSubgraphRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

QueryArtifactLineageSubgraphRequest

public static final class QueryArtifactLineageSubgraphRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>
implements QueryArtifactLineageSubgraphRequestOrBuilder

 Request message for
 [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph].
 

Protobuf type google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest

Method Summary

Modifier and Type	Method and Description
QueryArtifactLineageSubgraphRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
QueryArtifactLineageSubgraphRequest	build()
QueryArtifactLineageSubgraphRequest	buildPartial()
QueryArtifactLineageSubgraphRequest.Builder	clear()
QueryArtifactLineageSubgraphRequest.Builder	clearArtifact() Required.
QueryArtifactLineageSubgraphRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
QueryArtifactLineageSubgraphRequest.Builder	clearFilter() Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
QueryArtifactLineageSubgraphRequest.Builder	clearMaxHops() Specifies the size of the lineage graph in terms of number of hops from the specified artifact.
QueryArtifactLineageSubgraphRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
QueryArtifactLineageSubgraphRequest.Builder	clone()
String	getArtifact() Required.
com.google.protobuf.ByteString	getArtifactBytes() Required.
QueryArtifactLineageSubgraphRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
com.google.protobuf.ByteString	getFilterBytes() Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
int	getMaxHops() Specifies the size of the lineage graph in terms of number of hops from the specified artifact.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
QueryArtifactLineageSubgraphRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
QueryArtifactLineageSubgraphRequest.Builder	mergeFrom(com.google.protobuf.Message other)
QueryArtifactLineageSubgraphRequest.Builder	mergeFrom(QueryArtifactLineageSubgraphRequest other)
QueryArtifactLineageSubgraphRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
QueryArtifactLineageSubgraphRequest.Builder	setArtifact(String value) Required.
QueryArtifactLineageSubgraphRequest.Builder	setArtifactBytes(com.google.protobuf.ByteString value) Required.
QueryArtifactLineageSubgraphRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
QueryArtifactLineageSubgraphRequest.Builder	setFilter(String value) Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
QueryArtifactLineageSubgraphRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph.
QueryArtifactLineageSubgraphRequest.Builder	setMaxHops(int value) Specifies the size of the lineage graph in terms of number of hops from the specified artifact.
QueryArtifactLineageSubgraphRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
QueryArtifactLineageSubgraphRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

clear

public QueryArtifactLineageSubgraphRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

getDefaultInstanceForType

public QueryArtifactLineageSubgraphRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public QueryArtifactLineageSubgraphRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public QueryArtifactLineageSubgraphRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public QueryArtifactLineageSubgraphRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

setField

public QueryArtifactLineageSubgraphRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

clearField

public QueryArtifactLineageSubgraphRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

clearOneof

public QueryArtifactLineageSubgraphRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

setRepeatedField

public QueryArtifactLineageSubgraphRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                    int index,
                                                                    Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

addRepeatedField

public QueryArtifactLineageSubgraphRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

mergeFrom

public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryArtifactLineageSubgraphRequest.Builder>

mergeFrom

public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(QueryArtifactLineageSubgraphRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

mergeFrom

public QueryArtifactLineageSubgraphRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryArtifactLineageSubgraphRequest.Builder>

Throws:

IOException

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

Specified by:

getArtifact in interface QueryArtifactLineageSubgraphRequestOrBuilder

Returns:

The artifact.

getArtifactBytes

public com.google.protobuf.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) = { ... }

Specified by:

getArtifactBytes in interface QueryArtifactLineageSubgraphRequestOrBuilder

Returns:

The bytes for artifact.

setArtifact

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

Parameters:

value - The artifact to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setArtifactBytes

public QueryArtifactLineageSubgraphRequest.Builder setArtifactBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for artifact to set.

Returns:

This builder for chaining.

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;

Specified by:

getMaxHops in interface QueryArtifactLineageSubgraphRequestOrBuilder

Returns:

The maxHops.

setMaxHops

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;

Parameters:

value - The maxHops to set.

Returns:

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:

This builder for chaining.

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

Specified by:

getFilter in interface QueryArtifactLineageSubgraphRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.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`
    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;

Specified by:

getFilterBytes in interface QueryArtifactLineageSubgraphRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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`
    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:

This builder for chaining.

setFilterBytes

public QueryArtifactLineageSubgraphRequest.Builder setFilterBytes(com.google.protobuf.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`
    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;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final QueryArtifactLineageSubgraphRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>

mergeUnknownFields

public final QueryArtifactLineageSubgraphRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryArtifactLineageSubgraphRequest.Builder>