Package org.mlflow.api.proto

Class Service.LogMetric.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public Service.LogMetric.Builder mergeFrom(Service.LogMetric 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.LogMetric.Builder>

    • mergeFrom

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

    • hasRunId

      public boolean hasRunId()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Specified by:
      hasRunId in interface Service.LogMetricOrBuilder
      Returns:
      Whether the runId field is set.

    • getRunId

      public String getRunId()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Specified by:
      getRunId in interface Service.LogMetricOrBuilder
      Returns:
      The runId.

    • getRunIdBytes

      public com.google.protobuf.ByteString getRunIdBytes()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Specified by:
      getRunIdBytes in interface Service.LogMetricOrBuilder
      Returns:
      The bytes for runId.

    • setRunId

      public Service.LogMetric.Builder setRunId(String value)
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Parameters:
      value - The runId to set.
      Returns:
      This builder for chaining.

    • clearRunId

      public Service.LogMetric.Builder clearRunId()
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      Returns:
      This builder for chaining.

    • setRunIdBytes

      public Service.LogMetric.Builder setRunIdBytes(com.google.protobuf.ByteString value)
       ID of the run under which to log the metric. Must be provided.
      optional string run_id = 6;
      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 under which to log the metric. This field will
 be removed in a future MLflow version.
      optional string run_uuid = 1;
      Specified by:
      hasRunUuid in interface Service.LogMetricOrBuilder
      Returns:
      Whether the runUuid field is set.

    • getRunUuid

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

    • getRunUuidBytes

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

    • setRunUuid

      public Service.LogMetric.Builder setRunUuid(String value)
       [Deprecated, use run_id instead] ID of the run under which to log the metric. 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.LogMetric.Builder clearRunUuid()
       [Deprecated, use run_id instead] ID of the run under which to log the metric. This field will
 be removed in a future MLflow version.
      optional string run_uuid = 1;
      Returns:
      This builder for chaining.

    • setRunUuidBytes

      public Service.LogMetric.Builder setRunUuidBytes(com.google.protobuf.ByteString value)
       [Deprecated, use run_id instead] ID of the run under which to log the metric. 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.

    • hasKey

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

    • getKey

      public String getKey()
       Name of the metric.
      optional string key = 2 [(.mlflow.validate_required) = true];
      Specified by:
      getKey in interface Service.LogMetricOrBuilder
      Returns:
      The key.

    • getKeyBytes

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

    • setKey

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

    • clearKey

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

    • setKeyBytes

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

    • hasValue

      public boolean hasValue()
       Double value of the metric being logged.
      optional double value = 3 [(.mlflow.validate_required) = true];
      Specified by:
      hasValue in interface Service.LogMetricOrBuilder
      Returns:
      Whether the value field is set.

    • getValue

      public double getValue()
       Double value of the metric being logged.
      optional double value = 3 [(.mlflow.validate_required) = true];
      Specified by:
      getValue in interface Service.LogMetricOrBuilder
      Returns:
      The value.

    • setValue

      public Service.LogMetric.Builder setValue(double value)
       Double value of the metric being logged.
      optional double value = 3 [(.mlflow.validate_required) = true];
      Parameters:
      value - The value to set.
      Returns:
      This builder for chaining.

    • clearValue

      public Service.LogMetric.Builder clearValue()
       Double value of the metric being logged.
      optional double value = 3 [(.mlflow.validate_required) = true];
      Returns:
      This builder for chaining.

    • hasTimestamp

      public boolean hasTimestamp()
       Unix timestamp in milliseconds at the time metric was logged.
      optional int64 timestamp = 4 [(.mlflow.validate_required) = true];
      Specified by:
      hasTimestamp in interface Service.LogMetricOrBuilder
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      public long getTimestamp()
       Unix timestamp in milliseconds at the time metric was logged.
      optional int64 timestamp = 4 [(.mlflow.validate_required) = true];
      Specified by:
      getTimestamp in interface Service.LogMetricOrBuilder
      Returns:
      The timestamp.

    • setTimestamp

      public Service.LogMetric.Builder setTimestamp(long value)
       Unix timestamp in milliseconds at the time metric was logged.
      optional int64 timestamp = 4 [(.mlflow.validate_required) = true];
      Parameters:
      value - The timestamp to set.
      Returns:
      This builder for chaining.

    • clearTimestamp

      public Service.LogMetric.Builder clearTimestamp()
       Unix timestamp in milliseconds at the time metric was logged.
      optional int64 timestamp = 4 [(.mlflow.validate_required) = true];
      Returns:
      This builder for chaining.

    • hasStep

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

    • getStep

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

    • setStep

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

    • clearStep

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

    • hasModelId

      public boolean hasModelId()
       ID of the logged model associated with the metric, if applicable
      optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      hasModelId in interface Service.LogMetricOrBuilder
      Returns:
      Whether the modelId field is set.

    • getModelId

      public String getModelId()
       ID of the logged model associated with the metric, if applicable
      optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      getModelId in interface Service.LogMetricOrBuilder
      Returns:
      The modelId.

    • getModelIdBytes

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

    • setModelId

      public Service.LogMetric.Builder setModelId(String value)
       ID of the logged model 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.LogMetric.Builder clearModelId()
       ID of the logged model associated with the metric, if applicable
      optional string model_id = 7 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      This builder for chaining.

    • setModelIdBytes

      public Service.LogMetric.Builder setModelIdBytes(com.google.protobuf.ByteString value)
       ID of the logged model 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.

    • 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 = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      hasDatasetName in interface Service.LogMetricOrBuilder
      Returns:
      Whether the datasetName field is set.

    • getDatasetName

      public 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 = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      getDatasetName in interface Service.LogMetricOrBuilder
      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 = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      getDatasetNameBytes in interface Service.LogMetricOrBuilder
      Returns:
      The bytes for datasetName.

    • setDatasetName

      public Service.LogMetric.Builder setDatasetName(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 = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Parameters:
      value - The datasetName to set.
      Returns:
      This builder for chaining.

    • clearDatasetName

      public Service.LogMetric.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 = 8 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      This builder for chaining.

    • setDatasetNameBytes

      public Service.LogMetric.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 = 8 [(.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 = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      hasDatasetDigest in interface Service.LogMetricOrBuilder
      Returns:
      Whether the datasetDigest field is set.

    • getDatasetDigest

      public 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 = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      getDatasetDigest in interface Service.LogMetricOrBuilder
      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 = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Specified by:
      getDatasetDigestBytes in interface Service.LogMetricOrBuilder
      Returns:
      The bytes for datasetDigest.

    • setDatasetDigest

      public Service.LogMetric.Builder setDatasetDigest(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 = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Parameters:
      value - The datasetDigest to set.
      Returns:
      This builder for chaining.

    • clearDatasetDigest

      public Service.LogMetric.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 = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Returns:
      This builder for chaining.

    • setDatasetDigestBytes

      public Service.LogMetric.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 = 9 [(.mlflow.visibility) = PUBLIC_UNDOCUMENTED];
      Parameters:
      value - The bytes for datasetDigest to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

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

    • mergeUnknownFields

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