Package org.mlflow.api.proto

Class Jobs.JobProgress.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobProgress.Builder>

org.mlflow.api.proto.Jobs.JobProgress.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Jobs.JobProgressOrBuilder

Enclosing class:

Jobs.JobProgress

public static final class Jobs.JobProgress.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobProgress.Builder>
implements Jobs.JobProgressOrBuilder

 Structured best-effort progress payload for a running job.
 

Protobuf type mlflow.JobProgress

Method Summary

Modifier and Type	Method	Description
Jobs.JobProgress.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Jobs.JobProgress	build()
Jobs.JobProgress	buildPartial()
Jobs.JobProgress.Builder	clear()
Jobs.JobProgress.Builder	clearCompleted()	Amount of work completed so far, e.g.
Jobs.JobProgress.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Jobs.JobProgress.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Jobs.JobProgress.Builder	clearPhase()	Current phase or stage of the job, e.g.
Jobs.JobProgress.Builder	clearTotal()	Total amount of work, if known, e.g.
Jobs.JobProgress.Builder	clearUnit()	Unit for the ``completed`` and ``total`` values, e.g.
Jobs.JobProgress.Builder	clone()
long	getCompleted()	Amount of work completed so far, e.g.
Jobs.JobProgress	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
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.
boolean	hasCompleted()	Amount of work completed so far, e.g.
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()
Jobs.JobProgress.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Jobs.JobProgress.Builder	mergeFrom(com.google.protobuf.Message other)
Jobs.JobProgress.Builder	mergeFrom(Jobs.JobProgress other)
final Jobs.JobProgress.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Jobs.JobProgress.Builder	setCompleted(long value)	Amount of work completed so far, e.g.
Jobs.JobProgress.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Jobs.JobProgress.Builder	setPhase(String value)	Current phase or stage of the job, e.g.
Jobs.JobProgress.Builder	setPhaseBytes(com.google.protobuf.ByteString value)	Current phase or stage of the job, e.g.
Jobs.JobProgress.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Jobs.JobProgress.Builder	setTotal(long value)	Total amount of work, if known, e.g.
Jobs.JobProgress.Builder	setUnit(String value)	Unit for the ``completed`` and ``total`` values, e.g.
Jobs.JobProgress.Builder	setUnitBytes(com.google.protobuf.ByteString value)	Unit for the ``completed`` and ``total`` values, e.g.
final Jobs.JobProgress.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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<Jobs.JobProgress.Builder>

clear

public Jobs.JobProgress.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<Jobs.JobProgress.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<Jobs.JobProgress.Builder>

getDefaultInstanceForType

public Jobs.JobProgress getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Jobs.JobProgress build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Jobs.JobProgress buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

setField

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

clearField

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

clearOneof

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

setRepeatedField

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

addRepeatedField

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

mergeFrom

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

mergeFrom

public Jobs.JobProgress.Builder mergeFrom(Jobs.JobProgress other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobProgress.Builder>

mergeFrom

public Jobs.JobProgress.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<Jobs.JobProgress.Builder>

Throws:

IOException

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.

setPhase

public Jobs.JobProgress.Builder setPhase(String value)

 Current phase or stage of the job, e.g. ``"scoring traces"``.
 

optional string phase = 1;

Parameters:

value - The phase to set.

Returns:

This builder for chaining.

clearPhase

public Jobs.JobProgress.Builder clearPhase()

 Current phase or stage of the job, e.g. ``"scoring traces"``.
 

optional string phase = 1;

Returns:

This builder for chaining.

setPhaseBytes

public Jobs.JobProgress.Builder setPhaseBytes(com.google.protobuf.ByteString value)

 Current phase or stage of the job, e.g. ``"scoring traces"``.
 

optional string phase = 1;

Parameters:

value - The bytes for phase to set.

Returns:

This builder for chaining.

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.

setCompleted

public Jobs.JobProgress.Builder setCompleted(long value)

 Amount of work completed so far, e.g. ``42``.
 

optional int64 completed = 2;

Parameters:

value - The completed to set.

Returns:

This builder for chaining.

clearCompleted

public Jobs.JobProgress.Builder clearCompleted()

 Amount of work completed so far, e.g. ``42``.
 

optional int64 completed = 2;

Returns:

This builder for chaining.

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.

setTotal

public Jobs.JobProgress.Builder setTotal(long value)

 Total amount of work, if known, e.g. ``100``.
 

optional int64 total = 3;

Parameters:

value - The total to set.

Returns:

This builder for chaining.

clearTotal

public Jobs.JobProgress.Builder clearTotal()

 Total amount of work, if known, e.g. ``100``.
 

optional int64 total = 3;

Returns:

This builder for chaining.

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.

setUnit

public Jobs.JobProgress.Builder setUnit(String value)

 Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
 

optional string unit = 4;

Parameters:

value - The unit to set.

Returns:

This builder for chaining.

clearUnit

public Jobs.JobProgress.Builder clearUnit()

 Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
 

optional string unit = 4;

Returns:

This builder for chaining.

setUnitBytes

public Jobs.JobProgress.Builder setUnitBytes(com.google.protobuf.ByteString value)

 Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
 

optional string unit = 4;

Parameters:

value - The bytes for unit to set.

Returns:

This builder for chaining.

setUnknownFields

public final Jobs.JobProgress.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<Jobs.JobProgress.Builder>

mergeUnknownFields

public final Jobs.JobProgress.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<Jobs.JobProgress.Builder>