Package org.mlflow.api.proto

Class Service.GetMetricHistoryBulkInterval.Builder

    • Method Detail

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

      • 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

      • 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 java.io.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:
        java.io.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.

      • getRunIds

        public java.lang.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,
                                                              java.lang.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​(java.lang.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​(java.lang.Iterable<java.lang.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.

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

      • setMetricKey

        public Service.GetMetricHistoryBulkInterval.Builder setMetricKey​(java.lang.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.

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