Package org.mlflow.api.proto

Class Service.SearchTraces

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.SearchTraces
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.SearchTracesOrBuilder
Enclosing class:
Service
public static final class Service.SearchTraces extends com.google.protobuf.GeneratedMessageV3 implements Service.SearchTracesOrBuilder
Protobuf type mlflow.SearchTraces
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Service.SearchTraces.Builder
    Protobuf type mlflow.SearchTraces
    static final class 
    Service.SearchTraces.Response
    Protobuf type mlflow.SearchTraces.Response
    static interface 
    Service.SearchTraces.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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXPERIMENT_IDS_FIELD_NUMBER
     
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    MAX_RESULTS_FIELD_NUMBER
     
    static final int
    ORDER_BY_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<Service.SearchTraces>
    PARSER
    Deprecated.

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Service.SearchTraces
    getDefaultInstance()
     
    Service.SearchTraces
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getExperimentIds(int index)
    List of experiment IDs to search over.
    com.google.protobuf.ByteString
    getExperimentIdsBytes(int index)
    List of experiment IDs to search over.
    int
    getExperimentIdsCount()
    List of experiment IDs to search over.
    com.google.protobuf.ProtocolStringList
    getExperimentIdsList()
    List of experiment IDs to search over.
    String
    getFilter()
    A filter expression over trace attributes and tags that allows returning a subset of traces.
    com.google.protobuf.ByteString
    getFilterBytes()
    A filter expression over trace attributes and tags that allows returning a subset of traces.
    int
    getMaxResults()
    Maximum number of traces desired.
    String
    getOrderBy(int index)
    List of columns for ordering the results, e.g.
    com.google.protobuf.ByteString
    getOrderByBytes(int index)
    List of columns for ordering the results, e.g.
    int
    getOrderByCount()
    List of columns for ordering the results, e.g.
    com.google.protobuf.ProtocolStringList
    getOrderByList()
    List of columns for ordering the results, e.g.
    String
    getPageToken()
    Token indicating the page of traces to fetch.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Token indicating the page of traces to fetch.
    com.google.protobuf.Parser<Service.SearchTraces>
    getParserForType()
     
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    boolean
    hasFilter()
    A filter expression over trace attributes and tags that allows returning a subset of traces.
    int
    hashCode()
     
    boolean
    hasMaxResults()
    Maximum number of traces desired.
    boolean
    hasPageToken()
    Token indicating the page of traces to fetch.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Service.SearchTraces.Builder
    newBuilder()
     
    static Service.SearchTraces.Builder
    newBuilder(Service.SearchTraces prototype)
     
    Service.SearchTraces.Builder
    newBuilderForType()
     
    protected Service.SearchTraces.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Service.SearchTraces
    parseDelimitedFrom(InputStream input)
     
    static Service.SearchTraces
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.SearchTraces
    parseFrom(byte[] data)
     
    static Service.SearchTraces
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.SearchTraces
    parseFrom(com.google.protobuf.ByteString data)
     
    static Service.SearchTraces
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.SearchTraces
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Service.SearchTraces
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.SearchTraces
    parseFrom(InputStream input)
     
    static Service.SearchTraces
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Service.SearchTraces
    parseFrom(ByteBuffer data)
     
    static Service.SearchTraces
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Service.SearchTraces>
    parser()
     
    Service.SearchTraces.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected 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

    • getExperimentIdsList

      public com.google.protobuf.ProtocolStringList getExperimentIdsList()
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Specified by:
      getExperimentIdsList in interface Service.SearchTracesOrBuilder
      Returns:
      A list containing the experimentIds.

    • getExperimentIdsCount

      public int getExperimentIdsCount()
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Specified by:
      getExperimentIdsCount in interface Service.SearchTracesOrBuilder
      Returns:
      The count of experimentIds.

    • getExperimentIds

      public String getExperimentIds(int index)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Specified by:
      getExperimentIds in interface Service.SearchTracesOrBuilder
      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)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Specified by:
      getExperimentIdsBytes in interface Service.SearchTracesOrBuilder
      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 = 2;
      Specified by:
      hasFilter in interface Service.SearchTracesOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public 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 = 2;
      Specified by:
      getFilter in interface Service.SearchTracesOrBuilder
      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 = 2;
      Specified by:
      getFilterBytes in interface Service.SearchTracesOrBuilder
      Returns:
      The bytes for filter.

    • hasMaxResults

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

    • getMaxResults

      public int getMaxResults()
       Maximum number of traces desired. Max threshold is 500.
      optional int32 max_results = 3 [default = 100];
      Specified by:
      getMaxResults in interface Service.SearchTracesOrBuilder
      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 = 4;
      Specified by:
      getOrderByList in interface Service.SearchTracesOrBuilder
      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 = 4;
      Specified by:
      getOrderByCount in interface Service.SearchTracesOrBuilder
      Returns:
      The count of orderBy.

    • getOrderBy

      public String getOrderBy(int index)
       List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
      repeated string order_by = 4;
      Specified by:
      getOrderBy in interface Service.SearchTracesOrBuilder
      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 = 4;
      Specified by:
      getOrderByBytes in interface Service.SearchTracesOrBuilder
      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.
      optional string page_token = 5;
      Specified by:
      hasPageToken in interface Service.SearchTracesOrBuilder
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      public String getPageToken()
       Token indicating the page of traces to fetch.
      optional string page_token = 5;
      Specified by:
      getPageToken in interface Service.SearchTracesOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Token indicating the page of traces to fetch.
      optional string page_token = 5;
      Specified by:
      getPageTokenBytes in interface Service.SearchTracesOrBuilder
      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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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.SearchTraces parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Service.SearchTraces 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.SearchTraces parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Service.SearchTraces parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Service.SearchTraces parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Service.SearchTraces.Builder newBuilder()

    • newBuilder

      public static Service.SearchTraces.Builder newBuilder(Service.SearchTraces prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Service.SearchTraces getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Service.SearchTraces> 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.SearchTraces getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder