Package org.mlflow.api.proto

Class Service.GetMetricHistory.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.GetMetricHistory.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.GetMetricHistory.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • setField

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

      • setRepeatedField

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

      • addRepeatedField

        public Service.GetMetricHistory.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.GetMetricHistory.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.GetMetricHistory.Builder>

      • mergeFrom

        public Service.GetMetricHistory.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.GetMetricHistory.Builder>
        Throws:
        java.io.IOException

      • hasRunId

        public boolean hasRunId()
         ID of the run from which to fetch metric values. Must be provided.
        optional string run_id = 3;
        Specified by:
        hasRunId in interface Service.GetMetricHistoryOrBuilder
        Returns:
        Whether the runId field is set.

      • getRunId

        public java.lang.String getRunId()
         ID of the run from which to fetch metric values. Must be provided.
        optional string run_id = 3;
        Specified by:
        getRunId in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The runId.

      • getRunIdBytes

        public com.google.protobuf.ByteString getRunIdBytes()
         ID of the run from which to fetch metric values. Must be provided.
        optional string run_id = 3;
        Specified by:
        getRunIdBytes in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The bytes for runId.

      • setRunId

        public Service.GetMetricHistory.Builder setRunId​(java.lang.String value)
         ID of the run from which to fetch metric values. Must be provided.
        optional string run_id = 3;
        Parameters:
        value - The runId to set.
        Returns:
        This builder for chaining.

      • clearRunId

        public Service.GetMetricHistory.Builder clearRunId()
         ID of the run from which to fetch metric values. Must be provided.
        optional string run_id = 3;
        Returns:
        This builder for chaining.

      • setRunIdBytes

        public Service.GetMetricHistory.Builder setRunIdBytes​(com.google.protobuf.ByteString value)
         ID of the run from which to fetch metric values. Must be provided.
        optional string run_id = 3;
        Parameters:
        value - The bytes for runId to set.
        Returns:
        This builder for chaining.

      • hasRunUuid

        public boolean hasRunUuid()
         [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        hasRunUuid in interface Service.GetMetricHistoryOrBuilder
        Returns:
        Whether the runUuid field is set.

      • getRunUuid

        public java.lang.String getRunUuid()
         [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        getRunUuid in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The runUuid.

      • getRunUuidBytes

        public com.google.protobuf.ByteString getRunUuidBytes()
         [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        getRunUuidBytes in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The bytes for runUuid.

      • setRunUuid

        public Service.GetMetricHistory.Builder setRunUuid​(java.lang.String value)
         [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
        optional string run_uuid = 1;
        Parameters:
        value - The runUuid to set.
        Returns:
        This builder for chaining.

      • clearRunUuid

        public Service.GetMetricHistory.Builder clearRunUuid()
         [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
        optional string run_uuid = 1;
        Returns:
        This builder for chaining.

      • setRunUuidBytes

        public Service.GetMetricHistory.Builder setRunUuidBytes​(com.google.protobuf.ByteString value)
         [Deprecated, use run_id instead] ID of the run from which to fetch metric values. This field
 will be removed in a future MLflow version.
        optional string run_uuid = 1;
        Parameters:
        value - The bytes for runUuid to set.
        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.GetMetricHistoryOrBuilder
        Returns:
        Whether the metricKey field is set.

      • getMetricKey

        public java.lang.String getMetricKey()
         Name of the metric.
        optional string metric_key = 2 [(.mlflow.validate_required) = true];
        Specified by:
        getMetricKey in interface Service.GetMetricHistoryOrBuilder
        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.GetMetricHistoryOrBuilder
        Returns:
        The bytes for metricKey.

      • setMetricKey

        public Service.GetMetricHistory.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.

      • clearMetricKey

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

      • setMetricKeyBytes

        public Service.GetMetricHistory.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.

      • hasPageToken

        public boolean hasPageToken()
         Token indicating the page of metric history to fetch
        optional string page_token = 4;
        Specified by:
        hasPageToken in interface Service.GetMetricHistoryOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Token indicating the page of metric history to fetch
        optional string page_token = 4;
        Specified by:
        getPageToken in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Token indicating the page of metric history to fetch
        optional string page_token = 4;
        Specified by:
        getPageTokenBytes in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public Service.GetMetricHistory.Builder setPageToken​(java.lang.String value)
         Token indicating the page of metric history to fetch
        optional string page_token = 4;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public Service.GetMetricHistory.Builder clearPageToken()
         Token indicating the page of metric history to fetch
        optional string page_token = 4;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

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

      • hasMaxResults

        public boolean hasMaxResults()
         Maximum number of logged instances of a metric for a run to return per call.
 Backend servers may restrict the value of `max_results` depending on performance requirements.
 Requests that do not specify this value will behave as non-paginated queries where all
 metric history values for a given metric within a run are returned in a single response.
        optional int32 max_results = 5;
        Specified by:
        hasMaxResults in interface Service.GetMetricHistoryOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public int getMaxResults()
         Maximum number of logged instances of a metric for a run to return per call.
 Backend servers may restrict the value of `max_results` depending on performance requirements.
 Requests that do not specify this value will behave as non-paginated queries where all
 metric history values for a given metric within a run are returned in a single response.
        optional int32 max_results = 5;
        Specified by:
        getMaxResults in interface Service.GetMetricHistoryOrBuilder
        Returns:
        The maxResults.

      • setMaxResults

        public Service.GetMetricHistory.Builder setMaxResults​(int value)
         Maximum number of logged instances of a metric for a run to return per call.
 Backend servers may restrict the value of `max_results` depending on performance requirements.
 Requests that do not specify this value will behave as non-paginated queries where all
 metric history values for a given metric within a run are returned in a single response.
        optional int32 max_results = 5;
        Parameters:
        value - The maxResults to set.
        Returns:
        This builder for chaining.

      • clearMaxResults

        public Service.GetMetricHistory.Builder clearMaxResults()
         Maximum number of logged instances of a metric for a run to return per call.
 Backend servers may restrict the value of `max_results` depending on performance requirements.
 Requests that do not specify this value will behave as non-paginated queries where all
 metric history values for a given metric within a run are returned in a single response.
        optional int32 max_results = 5;
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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