Package org.mlflow.api.proto

Class Service.LogMetric

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.LogMetric
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.LogMetricOrBuilder
Enclosing class:
Service
public static final class Service.LogMetric
extends com.google.protobuf.GeneratedMessageV3
implements Service.LogMetricOrBuilder
Protobuf type mlflow.LogMetric
See Also:
Serialized Form

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Service.LogMetric.Builder
    Protobuf type mlflow.LogMetric
    static class  Service.LogMetric.Response
    Protobuf type mlflow.LogMetric.Response
    static interface  Service.LogMetric.ResponseOrBuilder  

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int KEY_FIELD_NUMBER  
    static com.google.protobuf.Parser<Service.LogMetric> PARSER
    Deprecated.
    static int RUN_ID_FIELD_NUMBER  
    static int RUN_UUID_FIELD_NUMBER  
    static int STEP_FIELD_NUMBER  
    static int TIMESTAMP_FIELD_NUMBER  
    static int VALUE_FIELD_NUMBER  

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    static Service.LogMetric getDefaultInstance()  
    Service.LogMetric getDefaultInstanceForType()  
    static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
    java.lang.String getKey()
    Name of the metric.
    com.google.protobuf.ByteString getKeyBytes()
    Name of the metric.
    com.google.protobuf.Parser<Service.LogMetric> getParserForType()  
    java.lang.String getRunId()
    ID of the run under which to log the metric.
    com.google.protobuf.ByteString getRunIdBytes()
    ID of the run under which to log the metric.
    java.lang.String getRunUuid()
    [Deprecated, use run_id instead] ID of the run under which to log the metric.
    com.google.protobuf.ByteString getRunUuidBytes()
    [Deprecated, use run_id instead] ID of the run under which to log the metric.
    int getSerializedSize()  
    long getStep()
    Step at which to log the metric
    long getTimestamp()
    Unix timestamp in milliseconds at the time metric was logged.
    com.google.protobuf.UnknownFieldSet getUnknownFields()  
    double getValue()
    Double value of the metric being logged.
    int hashCode()  
    boolean hasKey()
    Name of the metric.
    boolean hasRunId()
    ID of the run under which to log the metric.
    boolean hasRunUuid()
    [Deprecated, use run_id instead] ID of the run under which to log the metric.
    boolean hasStep()
    Step at which to log the metric
    boolean hasTimestamp()
    Unix timestamp in milliseconds at the time metric was logged.
    boolean hasValue()
    Double value of the metric being logged.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
    boolean isInitialized()  
    static Service.LogMetric.Builder newBuilder()  
    static Service.LogMetric.Builder newBuilder​(Service.LogMetric prototype)  
    Service.LogMetric.Builder newBuilderForType()  
    protected Service.LogMetric.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
    static Service.LogMetric parseDelimitedFrom​(java.io.InputStream input)  
    static Service.LogMetric parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.LogMetric parseFrom​(byte[] data)  
    static Service.LogMetric parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.LogMetric parseFrom​(com.google.protobuf.ByteString data)  
    static Service.LogMetric parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.LogMetric parseFrom​(com.google.protobuf.CodedInputStream input)  
    static Service.LogMetric parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.LogMetric parseFrom​(java.io.InputStream input)  
    static Service.LogMetric parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.LogMetric parseFrom​(java.nio.ByteBuffer data)  
    static Service.LogMetric parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static com.google.protobuf.Parser<Service.LogMetric> parser()  
    Service.LogMetric.Builder toBuilder()  
    void writeTo​(com.google.protobuf.CodedOutputStream output)  

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

  • Method Details

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • 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

    • 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

    • getRunId

      public java.lang.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

    • 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

    • 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

    • getRunUuid

      public java.lang.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

    • 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

    • hasKey

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

    • getKey

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

    • 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

    • 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

    • 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

    • 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

    • 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

    • hasStep

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

    • getStep

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo​(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      java.io.IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals​(java.lang.Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Service.LogMetric parseFrom​(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.LogMetric parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.LogMetric parseFrom​(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.LogMetric parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.LogMetric parseFrom​(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.LogMetric parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.LogMetric parseFrom​(java.io.InputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static Service.LogMetric parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDelimitedFrom

      public static Service.LogMetric parseDelimitedFrom​(java.io.InputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDelimitedFrom

      public static Service.LogMetric parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static Service.LogMetric parseFrom​(com.google.protobuf.CodedInputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static Service.LogMetric parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • newBuilderForType

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

    • newBuilder

      public static Service.LogMetric.Builder newBuilder()

    • newBuilder

      public static Service.LogMetric.Builder newBuilder​(Service.LogMetric prototype)

    • toBuilder

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

    • newBuilderForType

      protected Service.LogMetric.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Service.LogMetric getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Service.LogMetric> parser()

    • getParserForType

      public com.google.protobuf.Parser<Service.LogMetric> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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