Package org.mlflow.api.proto

Class Service.LogParam.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

org.mlflow.api.proto.Service.LogParam.Builder

All Implemented Interfaces:

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

Enclosing class:

Service.LogParam

public static final class Service.LogParam.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Service.LogParam.Builder>
implements Service.LogParamOrBuilder

Protobuf type mlflow.LogParam

Method Summary

Modifier and Type	Method	Description
Service.LogParam.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Service.LogParam	build()
Service.LogParam	buildPartial()
Service.LogParam.Builder	clear()
Service.LogParam.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Service.LogParam.Builder	clearKey()	Name of the param.
Service.LogParam.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Service.LogParam.Builder	clearRunId()	ID of the run under which to log the param.
Service.LogParam.Builder	clearRunUuid()	[Deprecated, use run_id instead] ID of the run under which to log the param.
Service.LogParam.Builder	clearValue()	String value of the param being logged.
Service.LogParam.Builder	clone()
Service.LogParam	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getKey()	Name of the param.
com.google.protobuf.ByteString	getKeyBytes()	Name of the param.
String	getRunId()	ID of the run under which to log the param.
com.google.protobuf.ByteString	getRunIdBytes()	ID of the run under which to log the param.
String	getRunUuid()	[Deprecated, use run_id instead] ID of the run under which to log the param.
com.google.protobuf.ByteString	getRunUuidBytes()	[Deprecated, use run_id instead] ID of the run under which to log the param.
String	getValue()	String value of the param being logged.
com.google.protobuf.ByteString	getValueBytes()	String value of the param being logged.
boolean	hasKey()	Name of the param.
boolean	hasRunId()	ID of the run under which to log the param.
boolean	hasRunUuid()	[Deprecated, use run_id instead] ID of the run under which to log the param.
boolean	hasValue()	String value of the param being logged.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
Service.LogParam.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Service.LogParam.Builder	mergeFrom(com.google.protobuf.Message other)
Service.LogParam.Builder	mergeFrom(Service.LogParam other)
final Service.LogParam.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Service.LogParam.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Service.LogParam.Builder	setKey(String value)	Name of the param.
Service.LogParam.Builder	setKeyBytes(com.google.protobuf.ByteString value)	Name of the param.
Service.LogParam.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Service.LogParam.Builder	setRunId(String value)	ID of the run under which to log the param.
Service.LogParam.Builder	setRunIdBytes(com.google.protobuf.ByteString value)	ID of the run under which to log the param.
Service.LogParam.Builder	setRunUuid(String value)	[Deprecated, use run_id instead] ID of the run under which to log the param.
Service.LogParam.Builder	setRunUuidBytes(com.google.protobuf.ByteString value)	[Deprecated, use run_id instead] ID of the run under which to log the param.
final Service.LogParam.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Service.LogParam.Builder	setValue(String value)	String value of the param being logged.
Service.LogParam.Builder	setValueBytes(com.google.protobuf.ByteString value)	String value of the param being logged.

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, 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.LogParam.Builder>

clear

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

getDefaultInstanceForType

public Service.LogParam getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Service.LogParam build()

Specified by:

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

Specified by:

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

buildPartial

public Service.LogParam buildPartial()

Specified by:

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

Specified by:

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

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

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

mergeFrom

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

Throws:

IOException

hasRunId

public boolean hasRunId()

 ID of the run under which to log the param. Must be provided.
 

optional string run_id = 4;

Specified by:

hasRunId in interface Service.LogParamOrBuilder

Returns:

Whether the runId field is set.

getRunId

public String getRunId()

 ID of the run under which to log the param. Must be provided.
 

optional string run_id = 4;

Specified by:

getRunId in interface Service.LogParamOrBuilder

Returns:

The runId.

getRunIdBytes

public com.google.protobuf.ByteString getRunIdBytes()

 ID of the run under which to log the param. Must be provided.
 

optional string run_id = 4;

Specified by:

getRunIdBytes in interface Service.LogParamOrBuilder

Returns:

The bytes for runId.

setRunId

public Service.LogParam.Builder setRunId(String value)

 ID of the run under which to log the param. Must be provided.
 

optional string run_id = 4;

Parameters:

value - The runId to set.

Returns:

This builder for chaining.

clearRunId

public Service.LogParam.Builder clearRunId()

 ID of the run under which to log the param. Must be provided.
 

optional string run_id = 4;

Returns:

This builder for chaining.

setRunIdBytes

public Service.LogParam.Builder setRunIdBytes(com.google.protobuf.ByteString value)

 ID of the run under which to log the param. Must be provided.
 

optional string run_id = 4;

Parameters:

value - The bytes for runId to set.

Returns:

This builder for chaining.

hasRunUuid

public boolean hasRunUuid()

 [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Specified by:

hasRunUuid in interface Service.LogParamOrBuilder

Returns:

Whether the runUuid field is set.

getRunUuid

public String getRunUuid()

 [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Specified by:

getRunUuid in interface Service.LogParamOrBuilder

Returns:

The runUuid.

getRunUuidBytes

public com.google.protobuf.ByteString getRunUuidBytes()

 [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Specified by:

getRunUuidBytes in interface Service.LogParamOrBuilder

Returns:

The bytes for runUuid.

setRunUuid

public Service.LogParam.Builder setRunUuid(String value)

 [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Parameters:

value - The runUuid to set.

Returns:

This builder for chaining.

clearRunUuid

public Service.LogParam.Builder clearRunUuid()

 [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Returns:

This builder for chaining.

setRunUuidBytes

public Service.LogParam.Builder setRunUuidBytes(com.google.protobuf.ByteString value)

 [Deprecated, use run_id instead] ID of the run under which to log the param. This field will
 be removed in a future MLflow version.
 

optional string run_uuid = 1;

Parameters:

value - The bytes for runUuid to set.

Returns:

This builder for chaining.

hasKey

public boolean hasKey()

 Name of the param. Maximum size is 255 bytes.
 

optional string key = 2 [(.mlflow.validate_required) = true];

Specified by:

hasKey in interface Service.LogParamOrBuilder

Returns:

Whether the key field is set.

getKey

public String getKey()

 Name of the param. Maximum size is 255 bytes.
 

optional string key = 2 [(.mlflow.validate_required) = true];

Specified by:

getKey in interface Service.LogParamOrBuilder

Returns:

The key.

getKeyBytes

public com.google.protobuf.ByteString getKeyBytes()

 Name of the param. Maximum size is 255 bytes.
 

optional string key = 2 [(.mlflow.validate_required) = true];

Specified by:

getKeyBytes in interface Service.LogParamOrBuilder

Returns:

The bytes for key.

setKey

public Service.LogParam.Builder setKey(String value)

 Name of the param. Maximum size is 255 bytes.
 

optional string key = 2 [(.mlflow.validate_required) = true];

Parameters:

value - The key to set.

Returns:

This builder for chaining.

clearKey

public Service.LogParam.Builder clearKey()

 Name of the param. Maximum size is 255 bytes.
 

optional string key = 2 [(.mlflow.validate_required) = true];

Returns:

This builder for chaining.

setKeyBytes

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

 Name of the param. Maximum size is 255 bytes.
 

optional string key = 2 [(.mlflow.validate_required) = true];

Parameters:

value - The bytes for key to set.

Returns:

This builder for chaining.

hasValue

public boolean hasValue()

 String value of the param being logged. Maximum size is 6000 bytes.
 

optional string value = 3 [(.mlflow.validate_required) = true];

Specified by:

hasValue in interface Service.LogParamOrBuilder

Returns:

Whether the value field is set.

getValue

public String getValue()

 String value of the param being logged. Maximum size is 6000 bytes.
 

optional string value = 3 [(.mlflow.validate_required) = true];

Specified by:

getValue in interface Service.LogParamOrBuilder

Returns:

The value.

getValueBytes

public com.google.protobuf.ByteString getValueBytes()

 String value of the param being logged. Maximum size is 6000 bytes.
 

optional string value = 3 [(.mlflow.validate_required) = true];

Specified by:

getValueBytes in interface Service.LogParamOrBuilder

Returns:

The bytes for value.

setValue

public Service.LogParam.Builder setValue(String value)

 String value of the param being logged. Maximum size is 6000 bytes.
 

optional string value = 3 [(.mlflow.validate_required) = true];

Parameters:

value - The value to set.

Returns:

This builder for chaining.

clearValue

public Service.LogParam.Builder clearValue()

 String value of the param being logged. Maximum size is 6000 bytes.
 

optional string value = 3 [(.mlflow.validate_required) = true];

Returns:

This builder for chaining.

setValueBytes

public Service.LogParam.Builder setValueBytes(com.google.protobuf.ByteString value)

 String value of the param being logged. Maximum size is 6000 bytes.
 

optional string value = 3 [(.mlflow.validate_required) = true];

Parameters:

value - The bytes for value to set.

Returns:

This builder for chaining.

setUnknownFields

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

mergeUnknownFields

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