Package org.mlflow.api.proto

Class Jobs.JobProgress

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Jobs.JobProgress
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Jobs.JobProgressOrBuilder
Enclosing class:
Jobs
public static final class Jobs.JobProgress extends com.google.protobuf.GeneratedMessageV3 implements Jobs.JobProgressOrBuilder
 Structured best-effort progress payload for a running job.
Protobuf type mlflow.JobProgress
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Jobs.JobProgress.Builder
    Structured best-effort progress payload for a running job.

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COMPLETED_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<Jobs.JobProgress>
    PARSER
    Deprecated.
    static final int
    PHASE_FIELD_NUMBER
     
    static final int
    TOTAL_FIELD_NUMBER
     
    static final int
    UNIT_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(Object obj)
     
    long
    getCompleted()
    Amount of work completed so far, e.g.
    static Jobs.JobProgress
    getDefaultInstance()
     
    Jobs.JobProgress
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Jobs.JobProgress>
    getParserForType()
     
    String
    getPhase()
    Current phase or stage of the job, e.g.
    com.google.protobuf.ByteString
    getPhaseBytes()
    Current phase or stage of the job, e.g.
    int
    getSerializedSize()
     
    long
    getTotal()
    Total amount of work, if known, e.g.
    String
    getUnit()
    Unit for the ``completed`` and ``total`` values, e.g.
    com.google.protobuf.ByteString
    getUnitBytes()
    Unit for the ``completed`` and ``total`` values, e.g.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    boolean
    hasCompleted()
    Amount of work completed so far, e.g.
    int
    hashCode()
     
    boolean
    hasPhase()
    Current phase or stage of the job, e.g.
    boolean
    hasTotal()
    Total amount of work, if known, e.g.
    boolean
    hasUnit()
    Unit for the ``completed`` and ``total`` values, e.g.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Jobs.JobProgress.Builder
    newBuilder()
     
    static Jobs.JobProgress.Builder
    newBuilder(Jobs.JobProgress prototype)
     
    Jobs.JobProgress.Builder
    newBuilderForType()
     
    protected Jobs.JobProgress.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Jobs.JobProgress
    parseDelimitedFrom(InputStream input)
     
    static Jobs.JobProgress
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobProgress
    parseFrom(byte[] data)
     
    static Jobs.JobProgress
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobProgress
    parseFrom(com.google.protobuf.ByteString data)
     
    static Jobs.JobProgress
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobProgress
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Jobs.JobProgress
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobProgress
    parseFrom(InputStream input)
     
    static Jobs.JobProgress
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobProgress
    parseFrom(ByteBuffer data)
     
    static Jobs.JobProgress
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Jobs.JobProgress>
    parser()
     
    Jobs.JobProgress.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • hasPhase

      public boolean hasPhase()
       Current phase or stage of the job, e.g. ``"scoring traces"``.
      optional string phase = 1;
      Specified by:
      hasPhase in interface Jobs.JobProgressOrBuilder
      Returns:
      Whether the phase field is set.

    • getPhase

      public String getPhase()
       Current phase or stage of the job, e.g. ``"scoring traces"``.
      optional string phase = 1;
      Specified by:
      getPhase in interface Jobs.JobProgressOrBuilder
      Returns:
      The phase.

    • getPhaseBytes

      public com.google.protobuf.ByteString getPhaseBytes()
       Current phase or stage of the job, e.g. ``"scoring traces"``.
      optional string phase = 1;
      Specified by:
      getPhaseBytes in interface Jobs.JobProgressOrBuilder
      Returns:
      The bytes for phase.

    • hasCompleted

      public boolean hasCompleted()
       Amount of work completed so far, e.g. ``42``.
      optional int64 completed = 2;
      Specified by:
      hasCompleted in interface Jobs.JobProgressOrBuilder
      Returns:
      Whether the completed field is set.

    • getCompleted

      public long getCompleted()
       Amount of work completed so far, e.g. ``42``.
      optional int64 completed = 2;
      Specified by:
      getCompleted in interface Jobs.JobProgressOrBuilder
      Returns:
      The completed.

    • hasTotal

      public boolean hasTotal()
       Total amount of work, if known, e.g. ``100``.
      optional int64 total = 3;
      Specified by:
      hasTotal in interface Jobs.JobProgressOrBuilder
      Returns:
      Whether the total field is set.

    • getTotal

      public long getTotal()
       Total amount of work, if known, e.g. ``100``.
      optional int64 total = 3;
      Specified by:
      getTotal in interface Jobs.JobProgressOrBuilder
      Returns:
      The total.

    • hasUnit

      public boolean hasUnit()
       Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
      optional string unit = 4;
      Specified by:
      hasUnit in interface Jobs.JobProgressOrBuilder
      Returns:
      Whether the unit field is set.

    • getUnit

      public String getUnit()
       Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
      optional string unit = 4;
      Specified by:
      getUnit in interface Jobs.JobProgressOrBuilder
      Returns:
      The unit.

    • getUnitBytes

      public com.google.protobuf.ByteString getUnitBytes()
       Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
      optional string unit = 4;
      Specified by:
      getUnitBytes in interface Jobs.JobProgressOrBuilder
      Returns:
      The bytes for unit.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 Jobs.JobProgress parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobProgress parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobProgress parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobProgress parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobProgress parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Jobs.JobProgress parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Jobs.JobProgress parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Jobs.JobProgress parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Jobs.JobProgress parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Jobs.JobProgress parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Jobs.JobProgress parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Jobs.JobProgress.Builder newBuilder()

    • newBuilder

      public static Jobs.JobProgress.Builder newBuilder(Jobs.JobProgress prototype)

    • toBuilder

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

    • newBuilderForType

      protected Jobs.JobProgress.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Jobs.JobProgress getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Jobs.JobProgress> parser()

    • getParserForType

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