Package com.google.cloud.aiplatform.v1

Class QueryArtifactLineageSubgraphRequest.Builder

    • 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>

      • 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

      • 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>

      • 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.