Package org.mlflow.api.proto

Class Service.Metric.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<Service.Metric.Builder>

com.google.protobuf.GeneratedMessageV3.Builder<Service.Metric.Builder>

org.mlflow.api.proto.Service.Metric.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Service.MetricOrBuilder

Enclosing class:

Service.Metric

public static final class Service.Metric.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Service.Metric.Builder>
implements Service.MetricOrBuilder

 Metric associated with a run, represented as a key-value pair.
 

Protobuf type mlflow.Metric

Method Summary

Modifier and Type	Method	Description
Service.Metric.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Service.Metric	build()
Service.Metric	buildPartial()
Service.Metric.Builder	clear()
Service.Metric.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Service.Metric.Builder	clearKey()	Key identifying this metric.
Service.Metric.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Service.Metric.Builder	clearStep()	Step at which to log the metric.
Service.Metric.Builder	clearTimestamp()	The timestamp at which this metric was recorded.
Service.Metric.Builder	clearValue()	Value associated with this metric.
Service.Metric.Builder	clone()
Service.Metric	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getKey()	Key identifying this metric.
com.google.protobuf.ByteString	getKeyBytes()	Key identifying this metric.
long	getStep()	Step at which to log the metric.
long	getTimestamp()	The timestamp at which this metric was recorded.
double	getValue()	Value associated with this metric.
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()
final boolean	isInitialized()
Service.Metric.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Service.Metric.Builder	mergeFrom(com.google.protobuf.Message other)
Service.Metric.Builder	mergeFrom(Service.Metric other)
final Service.Metric.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Service.Metric.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Service.Metric.Builder	setKey(String value)	Key identifying this metric.
Service.Metric.Builder	setKeyBytes(com.google.protobuf.ByteString value)	Key identifying this metric.
Service.Metric.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Service.Metric.Builder	setStep(long value)	Step at which to log the metric.
Service.Metric.Builder	setTimestamp(long value)	The timestamp at which this metric was recorded.
final Service.Metric.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Service.Metric.Builder	setValue(double value)	Value associated with this metric.

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

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

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

addAll, addAll, 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.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<Service.Metric.Builder>

clear

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

getDefaultInstanceForType

public Service.Metric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Service.Metric build()

Specified by:

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

Specified by:

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

buildPartial

public Service.Metric buildPartial()

Specified by:

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

Specified by:

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

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

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

mergeFrom

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

Throws:

IOException

hasKey

public boolean hasKey()

 Key identifying this metric.
 

optional string key = 1;

Specified by:

hasKey in interface Service.MetricOrBuilder

Returns:

Whether the key field is set.

getKey

public String getKey()

 Key identifying this metric.
 

optional string key = 1;

Specified by:

getKey in interface Service.MetricOrBuilder

Returns:

The key.

getKeyBytes

public com.google.protobuf.ByteString getKeyBytes()

 Key identifying this metric.
 

optional string key = 1;

Specified by:

getKeyBytes in interface Service.MetricOrBuilder

Returns:

The bytes for key.

setKey

public Service.Metric.Builder setKey(String value)

 Key identifying this metric.
 

optional string key = 1;

Parameters:

value - The key to set.

Returns:

This builder for chaining.

clearKey

public Service.Metric.Builder clearKey()

 Key identifying this metric.
 

optional string key = 1;

Returns:

This builder for chaining.

setKeyBytes

public Service.Metric.Builder setKeyBytes(com.google.protobuf.ByteString value)

 Key identifying this metric.
 

optional string key = 1;

Parameters:

value - The bytes for key to set.

Returns:

This builder for chaining.

hasValue

public boolean hasValue()

 Value associated with this metric.
 

optional double value = 2;

Specified by:

hasValue in interface Service.MetricOrBuilder

Returns:

Whether the value field is set.

getValue

public double getValue()

 Value associated with this metric.
 

optional double value = 2;

Specified by:

getValue in interface Service.MetricOrBuilder

Returns:

The value.

setValue

public Service.Metric.Builder setValue(double value)

 Value associated with this metric.
 

optional double value = 2;

Parameters:

value - The value to set.

Returns:

This builder for chaining.

clearValue

public Service.Metric.Builder clearValue()

 Value associated with this metric.
 

optional double value = 2;

Returns:

This builder for chaining.

hasTimestamp

public boolean hasTimestamp()

 The timestamp at which this metric was recorded.
 

optional int64 timestamp = 3;

Specified by:

hasTimestamp in interface Service.MetricOrBuilder

Returns:

Whether the timestamp field is set.

getTimestamp

public long getTimestamp()

 The timestamp at which this metric was recorded.
 

optional int64 timestamp = 3;

Specified by:

getTimestamp in interface Service.MetricOrBuilder

Returns:

The timestamp.

setTimestamp

public Service.Metric.Builder setTimestamp(long value)

 The timestamp at which this metric was recorded.
 

optional int64 timestamp = 3;

Parameters:

value - The timestamp to set.

Returns:

This builder for chaining.

clearTimestamp

public Service.Metric.Builder clearTimestamp()

 The timestamp at which this metric was recorded.
 

optional int64 timestamp = 3;

Returns:

This builder for chaining.

hasStep

public boolean hasStep()

 Step at which to log the metric.
 

optional int64 step = 4 [default = 0];

Specified by:

hasStep in interface Service.MetricOrBuilder

Returns:

Whether the step field is set.

getStep

public long getStep()

 Step at which to log the metric.
 

optional int64 step = 4 [default = 0];

Specified by:

getStep in interface Service.MetricOrBuilder

Returns:

The step.

setStep

public Service.Metric.Builder setStep(long value)

 Step at which to log the metric.
 

optional int64 step = 4 [default = 0];

Parameters:

value - The step to set.

Returns:

This builder for chaining.

clearStep

public Service.Metric.Builder clearStep()

 Step at which to log the metric.
 

optional int64 step = 4 [default = 0];

Returns:

This builder for chaining.

setUnknownFields

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

mergeUnknownFields

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