Package org.mlflow.api.proto

Class Service.SearchUnifiedTraces

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.SearchUnifiedTracesOrBuilder
    Enclosing class:
    Service
    public static final class Service.SearchUnifiedTraces
extends com.google.protobuf.GeneratedMessageV3
implements Service.SearchUnifiedTracesOrBuilder
    Protobuf type mlflow.SearchUnifiedTraces
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Service.SearchUnifiedTraces.Builder
      Protobuf type mlflow.SearchUnifiedTraces
      static class  Service.SearchUnifiedTraces.Response
      Protobuf type mlflow.SearchUnifiedTraces.Response
      static interface  Service.SearchUnifiedTraces.ResponseOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • getModelIdBytes

        public com.google.protobuf.ByteString getModelIdBytes()
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Specified by:
        getModelIdBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for modelId.

      • hasSqlWarehouseId

        public boolean hasSqlWarehouseId()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Specified by:
        hasSqlWarehouseId in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the sqlWarehouseId field is set.

      • getSqlWarehouseIdBytes

        public com.google.protobuf.ByteString getSqlWarehouseIdBytes()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Specified by:
        getSqlWarehouseIdBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for sqlWarehouseId.

      • getExperimentIdsList

        public com.google.protobuf.ProtocolStringList getExperimentIdsList()
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIdsList in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

        public int getExperimentIdsCount()
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIdsCount in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The count of experimentIds.

      • getExperimentIds

        public java.lang.String getExperimentIds​(int index)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIds in interface Service.SearchUnifiedTracesOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

        public com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIdsBytes in interface Service.SearchUnifiedTracesOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • hasFilter

        public boolean hasFilter()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Specified by:
        hasFilter in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the filter field is set.

      • getFilter

        public java.lang.String getFilter()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Specified by:
        getFilter in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Specified by:
        getFilterBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for filter.

      • hasMaxResults

        public boolean hasMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [default = 100];
        Specified by:
        hasMaxResults in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public int getMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [default = 100];
        Specified by:
        getMaxResults in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The maxResults.

      • getOrderByList

        public com.google.protobuf.ProtocolStringList getOrderByList()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderByList in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        A list containing the orderBy.

      • getOrderByCount

        public int getOrderByCount()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderByCount in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The count of orderBy.

      • getOrderBy

        public java.lang.String getOrderBy​(int index)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderBy in interface Service.SearchUnifiedTracesOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The orderBy at the given index.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes​(int index)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderByBytes in interface Service.SearchUnifiedTracesOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the orderBy at the given index.

      • hasPageToken

        public boolean hasPageToken()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Specified by:
        hasPageToken in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Specified by:
        getPageToken in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Specified by:
        getPageTokenBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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 Service.SearchUnifiedTraces parseFrom​(java.nio.ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.SearchUnifiedTraces parseFrom​(java.nio.ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.SearchUnifiedTraces parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Service.SearchUnifiedTraces parseFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Service.SearchUnifiedTraces parseFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Service.SearchUnifiedTraces parseDelimitedFrom​(java.io.InputStream input)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Service.SearchUnifiedTraces parseDelimitedFrom​(java.io.InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Service.SearchUnifiedTraces parseFrom​(com.google.protobuf.CodedInputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Service.SearchUnifiedTraces parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Service.SearchUnifiedTraces.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Service.SearchUnifiedTraces> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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