Package org.mlflow.api.proto

Class Service.Metric

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.Metric
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.MetricOrBuilder
Enclosing class:
Service
public static final class Service.Metric
extends com.google.protobuf.GeneratedMessageV3
implements Service.MetricOrBuilder
 Metric associated with a run, represented as a key-value pair.
Protobuf type mlflow.Metric
See Also:
Serialized Form

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Service.Metric.Builder
    Metric associated with a run, represented as a key-value pair.

    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.Metric> PARSER
    Deprecated.
    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.Metric getDefaultInstance()  
    Service.Metric getDefaultInstanceForType()  
    static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
    java.lang.String getKey()
    Key identifying this metric.
    com.google.protobuf.ByteString getKeyBytes()
    Key identifying this metric.
    com.google.protobuf.Parser<Service.Metric> getParserForType()  
    int getSerializedSize()  
    long getStep()
    Step at which to log the metric.
    long getTimestamp()
    The timestamp at which this metric was recorded.
    com.google.protobuf.UnknownFieldSet getUnknownFields()  
    double getValue()
    Value associated with this metric.
    int hashCode()  
    boolean hasKey()
    Key identifying this metric.
    boolean hasStep()
    Step at which to log the metric.
    boolean hasTimestamp()
    The timestamp at which this metric was recorded.
    boolean hasValue()
    Value associated with this metric.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
    boolean isInitialized()  
    static Service.Metric.Builder newBuilder()  
    static Service.Metric.Builder newBuilder​(Service.Metric prototype)  
    Service.Metric.Builder newBuilderForType()  
    protected Service.Metric.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
    static Service.Metric parseDelimitedFrom​(java.io.InputStream input)  
    static Service.Metric parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.Metric parseFrom​(byte[] data)  
    static Service.Metric parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.Metric parseFrom​(com.google.protobuf.ByteString data)  
    static Service.Metric parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.Metric parseFrom​(com.google.protobuf.CodedInputStream input)  
    static Service.Metric parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.Metric parseFrom​(java.io.InputStream input)  
    static Service.Metric parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static Service.Metric parseFrom​(java.nio.ByteBuffer data)  
    static Service.Metric parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static com.google.protobuf.Parser<Service.Metric> parser()  
    Service.Metric.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

    • hasKey

      public boolean hasKey()
       Key identifying this metric.
      optional string key = 1;
      Specified by:
      hasKey in interface Service.MetricOrBuilder

    • getKey

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

    • getKeyBytes

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

    • hasValue

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

    • getValue

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

    • hasTimestamp

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

    • getTimestamp

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

    • hasStep

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

    • getStep

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

    • 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.Metric parseFrom​(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Service.Metric 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.Metric parseFrom​(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Service.Metric.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Service.Metric getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Service.Metric> 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.Metric getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder