Package org.mlflow.api.proto

Class Service.SearchUnifiedTraces

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.SearchUnifiedTraces
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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:

  • 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

    • hasModelId

      public boolean hasModelId()
      optional string model_id = 1 [(.mlflow.validate_required) = true];
      Specified by:
      hasModelId in interface Service.SearchUnifiedTracesOrBuilder
      Returns:
      Whether the modelId field is set.

    • getModelId

      public String getModelId()
      optional string model_id = 1 [(.mlflow.validate_required) = true];
      Specified by:
      getModelId in interface Service.SearchUnifiedTracesOrBuilder
      Returns:
      The modelId.

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

    • getSqlWarehouseId

      public String getSqlWarehouseId()
      optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getSqlWarehouseId in interface Service.SearchUnifiedTracesOrBuilder
      Returns:
      The sqlWarehouseId.

    • 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 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 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 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 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 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.SearchUnifiedTraces parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.SearchUnifiedTraces parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

      public static Service.SearchUnifiedTraces parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      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

    • newBuilder

      public static Service.SearchUnifiedTraces.Builder newBuilder()

    • newBuilder

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

    • 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

    • getDefaultInstance

      public static Service.SearchUnifiedTraces getDefaultInstance()

    • parser

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

    • 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