Package org.mlflow.api.proto

Class Service.Metric.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, Service.MetricOrBuilder
    Enclosing class:
    Service.Metric
    public static final class Service.Metric.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Service.Metric.Builder>
implements Service.MetricOrBuilder
     Metric associated with a run, represented as a key-value pair.
    Protobuf type mlflow.Metric

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • mergeFrom

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

      • hasKey

        public boolean hasKey()
         Key identifying this metric.
        optional string key = 1;
        Specified by:
        hasKey in interface Service.MetricOrBuilder
        Returns:
        Whether the key field is set.

      • getKey

        public java.lang.String getKey()
         Key identifying this metric.
        optional string key = 1;
        Specified by:
        getKey in interface Service.MetricOrBuilder
        Returns:
        The key.

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         Key identifying this metric.
        optional string key = 1;
        Specified by:
        getKeyBytes in interface Service.MetricOrBuilder
        Returns:
        The bytes for key.

      • setKey

        public Service.Metric.Builder setKey​(java.lang.String value)
         Key identifying this metric.
        optional string key = 1;
        Parameters:
        value - The key to set.
        Returns:
        This builder for chaining.

      • clearKey

        public Service.Metric.Builder clearKey()
         Key identifying this metric.
        optional string key = 1;
        Returns:
        This builder for chaining.

      • setKeyBytes

        public Service.Metric.Builder setKeyBytes​(com.google.protobuf.ByteString value)
         Key identifying this metric.
        optional string key = 1;
        Parameters:
        value - The bytes for key to set.
        Returns:
        This builder for chaining.

      • hasValue

        public boolean hasValue()
         Value associated with this metric.
        optional double value = 2;
        Specified by:
        hasValue in interface Service.MetricOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public double getValue()
         Value associated with this metric.
        optional double value = 2;
        Specified by:
        getValue in interface Service.MetricOrBuilder
        Returns:
        The value.

      • setValue

        public Service.Metric.Builder setValue​(double value)
         Value associated with this metric.
        optional double value = 2;
        Parameters:
        value - The value to set.
        Returns:
        This builder for chaining.

      • clearValue

        public Service.Metric.Builder clearValue()
         Value associated with this metric.
        optional double value = 2;
        Returns:
        This builder for chaining.

      • hasTimestamp

        public boolean hasTimestamp()
         The timestamp at which this metric was recorded.
        optional int64 timestamp = 3;
        Specified by:
        hasTimestamp in interface Service.MetricOrBuilder
        Returns:
        Whether the timestamp field is set.

      • getTimestamp

        public long getTimestamp()
         The timestamp at which this metric was recorded.
        optional int64 timestamp = 3;
        Specified by:
        getTimestamp in interface Service.MetricOrBuilder
        Returns:
        The timestamp.

      • setTimestamp

        public Service.Metric.Builder setTimestamp​(long value)
         The timestamp at which this metric was recorded.
        optional int64 timestamp = 3;
        Parameters:
        value - The timestamp to set.
        Returns:
        This builder for chaining.

      • clearTimestamp

        public Service.Metric.Builder clearTimestamp()
         The timestamp at which this metric was recorded.
        optional int64 timestamp = 3;
        Returns:
        This builder for chaining.

      • hasStep

        public boolean hasStep()
         Step at which to log the metric.
        optional int64 step = 4 [default = 0];
        Specified by:
        hasStep in interface Service.MetricOrBuilder
        Returns:
        Whether the step field is set.

      • getStep

        public long getStep()
         Step at which to log the metric.
        optional int64 step = 4 [default = 0];
        Specified by:
        getStep in interface Service.MetricOrBuilder
        Returns:
        The step.

      • setStep

        public Service.Metric.Builder setStep​(long value)
         Step at which to log the metric.
        optional int64 step = 4 [default = 0];
        Parameters:
        value - The step to set.
        Returns:
        This builder for chaining.

      • clearStep

        public Service.Metric.Builder clearStep()
         Step at which to log the metric.
        optional int64 step = 4 [default = 0];
        Returns:
        This builder for chaining.

      • hasDatasetName

        public boolean hasDatasetName()
         The name of the dataset associated with the metric.
 E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
        optional string dataset_name = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        hasDatasetName in interface Service.MetricOrBuilder
        Returns:
        Whether the datasetName field is set.

      • getDatasetName

        public java.lang.String getDatasetName()
         The name of the dataset associated with the metric.
 E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
        optional string dataset_name = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getDatasetName in interface Service.MetricOrBuilder
        Returns:
        The datasetName.

      • getDatasetNameBytes

        public com.google.protobuf.ByteString getDatasetNameBytes()
         The name of the dataset associated with the metric.
 E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
        optional string dataset_name = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getDatasetNameBytes in interface Service.MetricOrBuilder
        Returns:
        The bytes for datasetName.

      • setDatasetName

        public Service.Metric.Builder setDatasetName​(java.lang.String value)
         The name of the dataset associated with the metric.
 E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
        optional string dataset_name = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The datasetName to set.
        Returns:
        This builder for chaining.

      • clearDatasetName

        public Service.Metric.Builder clearDatasetName()
         The name of the dataset associated with the metric.
 E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
        optional string dataset_name = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        This builder for chaining.

      • setDatasetNameBytes

        public Service.Metric.Builder setDatasetNameBytes​(com.google.protobuf.ByteString value)
         The name of the dataset associated with the metric.
 E.g. "my.uc.table@2" "nyc-taxi-dataset", "fantastic-elk-3"
        optional string dataset_name = 5 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The bytes for datasetName to set.
        Returns:
        This builder for chaining.

      • hasDatasetDigest

        public boolean hasDatasetDigest()
         Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
        optional string dataset_digest = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        hasDatasetDigest in interface Service.MetricOrBuilder
        Returns:
        Whether the datasetDigest field is set.

      • getDatasetDigest

        public java.lang.String getDatasetDigest()
         Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
        optional string dataset_digest = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getDatasetDigest in interface Service.MetricOrBuilder
        Returns:
        The datasetDigest.

      • getDatasetDigestBytes

        public com.google.protobuf.ByteString getDatasetDigestBytes()
         Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
        optional string dataset_digest = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getDatasetDigestBytes in interface Service.MetricOrBuilder
        Returns:
        The bytes for datasetDigest.

      • setDatasetDigest

        public Service.Metric.Builder setDatasetDigest​(java.lang.String value)
         Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
        optional string dataset_digest = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The datasetDigest to set.
        Returns:
        This builder for chaining.

      • clearDatasetDigest

        public Service.Metric.Builder clearDatasetDigest()
         Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
        optional string dataset_digest = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        This builder for chaining.

      • setDatasetDigestBytes

        public Service.Metric.Builder setDatasetDigestBytes​(com.google.protobuf.ByteString value)
         Dataset digest of the dataset associated with the metric,
 e.g. an md5 hash of the dataset that uniquely identifies it
 within datasets of the same name.
        optional string dataset_digest = 6 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The bytes for datasetDigest to set.
        Returns:
        This builder for chaining.

      • hasModelId

        public boolean hasModelId()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        hasModelId in interface Service.MetricOrBuilder
        Returns:
        Whether the modelId field is set.

      • getModelId

        public java.lang.String getModelId()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getModelId in interface Service.MetricOrBuilder
        Returns:
        The modelId.

      • getModelIdBytes

        public com.google.protobuf.ByteString getModelIdBytes()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getModelIdBytes in interface Service.MetricOrBuilder
        Returns:
        The bytes for modelId.

      • setModelId

        public Service.Metric.Builder setModelId​(java.lang.String value)
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The modelId to set.
        Returns:
        This builder for chaining.

      • clearModelId

        public Service.Metric.Builder clearModelId()
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        This builder for chaining.

      • setModelIdBytes

        public Service.Metric.Builder setModelIdBytes​(com.google.protobuf.ByteString value)
         The ID of the LoggedModel or Registered Model Version associated with
 the metric, if applicable.
        optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The bytes for modelId to set.
        Returns:
        This builder for chaining.

      • hasRunId

        public boolean hasRunId()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        hasRunId in interface Service.MetricOrBuilder
        Returns:
        Whether the runId field is set.

      • getRunId

        public java.lang.String getRunId()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getRunId in interface Service.MetricOrBuilder
        Returns:
        The runId.

      • getRunIdBytes

        public com.google.protobuf.ByteString getRunIdBytes()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Specified by:
        getRunIdBytes in interface Service.MetricOrBuilder
        Returns:
        The bytes for runId.

      • setRunId

        public Service.Metric.Builder setRunId​(java.lang.String value)
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The runId to set.
        Returns:
        This builder for chaining.

      • clearRunId

        public Service.Metric.Builder clearRunId()
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Returns:
        This builder for chaining.

      • setRunIdBytes

        public Service.Metric.Builder setRunIdBytes​(com.google.protobuf.ByteString value)
         The ID of the run containing the metric.
        optional string run_id = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
        Parameters:
        value - The bytes for runId to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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