Package org.mlflow.api.proto

Class Service.SearchTraces.Builder

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

  • Method Details Link icon

    • getDescriptor Link icon

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

    • internalGetFieldAccessorTable Link icon

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • clear Link icon

      public Service.SearchTraces.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • getDescriptorForType Link icon

      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<Service.SearchTraces.Builder>

    • getDefaultInstanceForType Link icon

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

    • build Link icon

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

    • buildPartial Link icon

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

    • clone Link icon

      public Service.SearchTraces.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • setField Link icon

      public Service.SearchTraces.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • clearField Link icon

      public Service.SearchTraces.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • clearOneof Link icon

      public Service.SearchTraces.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • setRepeatedField Link icon

      public Service.SearchTraces.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • addRepeatedField Link icon

      public Service.SearchTraces.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • mergeFrom Link icon

      public Service.SearchTraces.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.SearchTraces.Builder>

    • mergeFrom Link icon

      public Service.SearchTraces.Builder mergeFrom(Service.SearchTraces other)

    • isInitialized Link icon

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • mergeFrom Link icon

      public Service.SearchTraces.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.SearchTraces.Builder>
      Throws:
      IOException

    • getExperimentIdsList Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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.

    • setExperimentIds Link icon

      public Service.SearchTraces.Builder setExperimentIds(int index, String value)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Parameters:
      index - The index to set the value at.
      value - The experimentIds to set.
      Returns:
      This builder for chaining.

    • addExperimentIds Link icon

      public Service.SearchTraces.Builder addExperimentIds(String value)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Parameters:
      value - The experimentIds to add.
      Returns:
      This builder for chaining.

    • addAllExperimentIds Link icon

      public Service.SearchTraces.Builder addAllExperimentIds(Iterable<String> values)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Parameters:
      values - The experimentIds to add.
      Returns:
      This builder for chaining.

    • clearExperimentIds Link icon

      public Service.SearchTraces.Builder clearExperimentIds()
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Returns:
      This builder for chaining.

    • addExperimentIdsBytes Link icon

      public Service.SearchTraces.Builder addExperimentIdsBytes(com.google.protobuf.ByteString value)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Parameters:
      value - The bytes of the experimentIds to add.
      Returns:
      This builder for chaining.

    • hasFilter Link icon

      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 Link icon

      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 Link icon

      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.

    • setFilter Link icon

      public Service.SearchTraces.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter Link icon

      public Service.SearchTraces.Builder clearFilter()
       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;
      Returns:
      This builder for chaining.

    • setFilterBytes Link icon

      public Service.SearchTraces.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • hasMaxResults Link icon

      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 Link icon

      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.

    • setMaxResults Link icon

      public Service.SearchTraces.Builder setMaxResults(int value)
       Maximum number of traces desired. Max threshold is 500.
      optional int32 max_results = 3 [default = 100];
      Parameters:
      value - The maxResults to set.
      Returns:
      This builder for chaining.

    • clearMaxResults Link icon

      public Service.SearchTraces.Builder clearMaxResults()
       Maximum number of traces desired. Max threshold is 500.
      optional int32 max_results = 3 [default = 100];
      Returns:
      This builder for chaining.

    • getOrderByList Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      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.

    • setOrderBy Link icon

      public Service.SearchTraces.Builder setOrderBy(int index, String value)
       List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
      repeated string order_by = 4;
      Parameters:
      index - The index to set the value at.
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • addOrderBy Link icon

      public Service.SearchTraces.Builder addOrderBy(String value)
       List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
      repeated string order_by = 4;
      Parameters:
      value - The orderBy to add.
      Returns:
      This builder for chaining.

    • addAllOrderBy Link icon

      public Service.SearchTraces.Builder addAllOrderBy(Iterable<String> values)
       List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
      repeated string order_by = 4;
      Parameters:
      values - The orderBy to add.
      Returns:
      This builder for chaining.

    • clearOrderBy Link icon

      public Service.SearchTraces.Builder clearOrderBy()
       List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
      repeated string order_by = 4;
      Returns:
      This builder for chaining.

    • addOrderByBytes Link icon

      public Service.SearchTraces.Builder addOrderByBytes(com.google.protobuf.ByteString value)
       List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
      repeated string order_by = 4;
      Parameters:
      value - The bytes of the orderBy to add.
      Returns:
      This builder for chaining.

    • hasPageToken Link icon

      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 Link icon

      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 Link icon

      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.

    • setPageToken Link icon

      public Service.SearchTraces.Builder setPageToken(String value)
       Token indicating the page of traces to fetch.
      optional string page_token = 5;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken Link icon

      public Service.SearchTraces.Builder clearPageToken()
       Token indicating the page of traces to fetch.
      optional string page_token = 5;
      Returns:
      This builder for chaining.

    • setPageTokenBytes Link icon

      public Service.SearchTraces.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Token indicating the page of traces to fetch.
      optional string page_token = 5;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • setUnknownFields Link icon

      public final Service.SearchTraces.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>

    • mergeUnknownFields Link icon

      public final Service.SearchTraces.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchTraces.Builder>