Package com.google.cloud.aiplatform.v1

Class QueryArtifactLineageSubgraphRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest
All Implemented Interfaces:
QueryArtifactLineageSubgraphRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class QueryArtifactLineageSubgraphRequest extends com.google.protobuf.GeneratedMessage implements QueryArtifactLineageSubgraphRequestOrBuilder
 Request message for
 [MetadataService.QueryArtifactLineageSubgraph][google.cloud.aiplatform.v1.MetadataService.QueryArtifactLineageSubgraph].
Protobuf type google.cloud.aiplatform.v1.QueryArtifactLineageSubgraphRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

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

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryArtifactLineageSubgraphRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryArtifactLineageSubgraphRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryArtifactLineageSubgraphRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public QueryArtifactLineageSubgraphRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static QueryArtifactLineageSubgraphRequest.Builder newBuilder()

    • newBuilder

      public static QueryArtifactLineageSubgraphRequest.Builder newBuilder(QueryArtifactLineageSubgraphRequest prototype)

    • toBuilder

      public QueryArtifactLineageSubgraphRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected QueryArtifactLineageSubgraphRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static QueryArtifactLineageSubgraphRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<QueryArtifactLineageSubgraphRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<QueryArtifactLineageSubgraphRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public QueryArtifactLineageSubgraphRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder