Package org.mlflow.api.proto

Class Service.GetMetricHistoryBulkInterval.Builder

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

  • Method Details

    • 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.Builder<Service.GetMetricHistoryBulkInterval.Builder>

    • clear

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • getDescriptorForType

      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.GetMetricHistoryBulkInterval.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • setField

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • clearField

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • clearOneof

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • setRepeatedField

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • addRepeatedField

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • mergeFrom

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • mergeFrom

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

    • isInitialized

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

    • mergeFrom

      public Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>
      Throws:
      IOException

    • getRunIdsList

      public com.google.protobuf.ProtocolStringList getRunIdsList()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIdsList in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      A list containing the runIds.

    • getRunIdsCount

      public int getRunIdsCount()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIdsCount in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The count of runIds.

    • getRunIds

      public String getRunIds(int index)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIds in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The runIds at the given index.

    • getRunIdsBytes

      public com.google.protobuf.ByteString getRunIdsBytes(int index)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Specified by:
      getRunIdsBytes in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the runIds at the given index.

    • setRunIds

      public Service.GetMetricHistoryBulkInterval.Builder setRunIds(int index, String value)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Parameters:
      index - The index to set the value at.
      value - The runIds to set.
      Returns:
      This builder for chaining.

    • addRunIds

      public Service.GetMetricHistoryBulkInterval.Builder addRunIds(String value)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Parameters:
      value - The runIds to add.
      Returns:
      This builder for chaining.

    • addAllRunIds

      public Service.GetMetricHistoryBulkInterval.Builder addAllRunIds(Iterable<String> values)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Parameters:
      values - The runIds to add.
      Returns:
      This builder for chaining.

    • clearRunIds

      public Service.GetMetricHistoryBulkInterval.Builder clearRunIds()
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Returns:
      This builder for chaining.

    • addRunIdsBytes

      public Service.GetMetricHistoryBulkInterval.Builder addRunIdsBytes(com.google.protobuf.ByteString value)
       ID(s) of the run(s) from which to fetch metric values. Must be provided.
      repeated string run_ids = 1;
      Parameters:
      value - The bytes of the runIds to add.
      Returns:
      This builder for chaining.

    • hasMetricKey

      public boolean hasMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      hasMetricKey in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the metricKey field is set.

    • getMetricKey

      public String getMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getMetricKey in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The metricKey.

    • getMetricKeyBytes

      public com.google.protobuf.ByteString getMetricKeyBytes()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getMetricKeyBytes in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The bytes for metricKey.

    • setMetricKey

      public Service.GetMetricHistoryBulkInterval.Builder setMetricKey(String value)
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Parameters:
      value - The metricKey to set.
      Returns:
      This builder for chaining.

    • clearMetricKey

      public Service.GetMetricHistoryBulkInterval.Builder clearMetricKey()
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Returns:
      This builder for chaining.

    • setMetricKeyBytes

      public Service.GetMetricHistoryBulkInterval.Builder setMetricKeyBytes(com.google.protobuf.ByteString value)
       Name of the metric.
      optional string metric_key = 2 [(.mlflow.validate_required) = true];
      Parameters:
      value - The bytes for metricKey to set.
      Returns:
      This builder for chaining.

    • hasStartStep

      public boolean hasStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Specified by:
      hasStartStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the startStep field is set.

    • getStartStep

      public int getStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Specified by:
      getStartStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The startStep.

    • setStartStep

      public Service.GetMetricHistoryBulkInterval.Builder setStartStep(int value)
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Parameters:
      value - The startStep to set.
      Returns:
      This builder for chaining.

    • clearStartStep

      public Service.GetMetricHistoryBulkInterval.Builder clearStartStep()
       Optional start step to only fetch metrics after the specified step. Must be defined if
 end_step is defined.
      optional int32 start_step = 3;
      Returns:
      This builder for chaining.

    • hasEndStep

      public boolean hasEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Specified by:
      hasEndStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the endStep field is set.

    • getEndStep

      public int getEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Specified by:
      getEndStep in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The endStep.

    • setEndStep

      public Service.GetMetricHistoryBulkInterval.Builder setEndStep(int value)
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Parameters:
      value - The endStep to set.
      Returns:
      This builder for chaining.

    • clearEndStep

      public Service.GetMetricHistoryBulkInterval.Builder clearEndStep()
       Optional end step to only fetch metrics before the specified step. Must be defined if
 start_step is defined.
      optional int32 end_step = 4;
      Returns:
      This builder for chaining.

    • hasMaxResults

      public boolean hasMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Specified by:
      hasMaxResults in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      public int getMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Specified by:
      getMaxResults in interface Service.GetMetricHistoryBulkIntervalOrBuilder
      Returns:
      The maxResults.

    • setMaxResults

      public Service.GetMetricHistoryBulkInterval.Builder setMaxResults(int value)
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Parameters:
      value - The maxResults to set.
      Returns:
      This builder for chaining.

    • clearMaxResults

      public Service.GetMetricHistoryBulkInterval.Builder clearMaxResults()
       Maximum number of results to fetch per run specified. Must be set to a positive number.
 Note, in reality, the API returns at most (max_results + # of run IDs) x (# run IDs) metric
 data points.
      optional int32 max_results = 5;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>

    • mergeUnknownFields

      public final Service.GetMetricHistoryBulkInterval.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.GetMetricHistoryBulkInterval.Builder>