Package org.mlflow.api.proto

Class ModelRegistry.TransitionModelVersionStage.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.TransitionModelVersionStage.Builder>

org.mlflow.api.proto.ModelRegistry.TransitionModelVersionStage.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, ModelRegistry.TransitionModelVersionStageOrBuilder

Enclosing class:

ModelRegistry.TransitionModelVersionStage

public static final class ModelRegistry.TransitionModelVersionStage.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.TransitionModelVersionStage.Builder>
implements ModelRegistry.TransitionModelVersionStageOrBuilder

Protobuf type mlflow.TransitionModelVersionStage

Method Summary

Modifier and Type	Method	Description
ModelRegistry.TransitionModelVersionStage.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ModelRegistry.TransitionModelVersionStage	build()
ModelRegistry.TransitionModelVersionStage	buildPartial()
ModelRegistry.TransitionModelVersionStage.Builder	clear()
ModelRegistry.TransitionModelVersionStage.Builder	clearArchiveExistingVersions()	When transitioning a model version to a particular stage, this flag dictates whether all existing model versions in that stage should be atomically moved to the "archived" stage.
ModelRegistry.TransitionModelVersionStage.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ModelRegistry.TransitionModelVersionStage.Builder	clearName()	Name of the registered model
ModelRegistry.TransitionModelVersionStage.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ModelRegistry.TransitionModelVersionStage.Builder	clearStage()	Transition `model_version` to new stage.
ModelRegistry.TransitionModelVersionStage.Builder	clearVersion()	Model version number
ModelRegistry.TransitionModelVersionStage.Builder	clone()
boolean	getArchiveExistingVersions()	When transitioning a model version to a particular stage, this flag dictates whether all existing model versions in that stage should be atomically moved to the "archived" stage.
ModelRegistry.TransitionModelVersionStage	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getName()	Name of the registered model
com.google.protobuf.ByteString	getNameBytes()	Name of the registered model
String	getStage()	Transition `model_version` to new stage.
com.google.protobuf.ByteString	getStageBytes()	Transition `model_version` to new stage.
String	getVersion()	Model version number
com.google.protobuf.ByteString	getVersionBytes()	Model version number
boolean	hasArchiveExistingVersions()	When transitioning a model version to a particular stage, this flag dictates whether all existing model versions in that stage should be atomically moved to the "archived" stage.
boolean	hasName()	Name of the registered model
boolean	hasStage()	Transition `model_version` to new stage.
boolean	hasVersion()	Model version number
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
ModelRegistry.TransitionModelVersionStage.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ModelRegistry.TransitionModelVersionStage.Builder	mergeFrom(com.google.protobuf.Message other)
ModelRegistry.TransitionModelVersionStage.Builder	mergeFrom(ModelRegistry.TransitionModelVersionStage other)
final ModelRegistry.TransitionModelVersionStage.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ModelRegistry.TransitionModelVersionStage.Builder	setArchiveExistingVersions(boolean value)	When transitioning a model version to a particular stage, this flag dictates whether all existing model versions in that stage should be atomically moved to the "archived" stage.
ModelRegistry.TransitionModelVersionStage.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ModelRegistry.TransitionModelVersionStage.Builder	setName(String value)	Name of the registered model
ModelRegistry.TransitionModelVersionStage.Builder	setNameBytes(com.google.protobuf.ByteString value)	Name of the registered model
ModelRegistry.TransitionModelVersionStage.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ModelRegistry.TransitionModelVersionStage.Builder	setStage(String value)	Transition `model_version` to new stage.
ModelRegistry.TransitionModelVersionStage.Builder	setStageBytes(com.google.protobuf.ByteString value)	Transition `model_version` to new stage.
final ModelRegistry.TransitionModelVersionStage.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ModelRegistry.TransitionModelVersionStage.Builder	setVersion(String value)	Model version number
ModelRegistry.TransitionModelVersionStage.Builder	setVersionBytes(com.google.protobuf.ByteString value)	Model version number

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<ModelRegistry.TransitionModelVersionStage.Builder>

clear

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

getDefaultInstanceForType

public ModelRegistry.TransitionModelVersionStage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ModelRegistry.TransitionModelVersionStage build()

Specified by:

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

Specified by:

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

buildPartial

public ModelRegistry.TransitionModelVersionStage buildPartial()

Specified by:

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

Specified by:

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

clone

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

setField

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

clearField

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

clearOneof

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

setRepeatedField

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

addRepeatedField

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

mergeFrom

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

mergeFrom

public ModelRegistry.TransitionModelVersionStage.Builder mergeFrom(ModelRegistry.TransitionModelVersionStage other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.TransitionModelVersionStage.Builder>

mergeFrom

public ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

Throws:

IOException

hasName

public boolean hasName()

 Name of the registered model
 

optional string name = 1 [(.mlflow.validate_required) = true];

Specified by:

hasName in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

Whether the name field is set.

getName

public String getName()

 Name of the registered model
 

optional string name = 1 [(.mlflow.validate_required) = true];

Specified by:

getName in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Name of the registered model
 

optional string name = 1 [(.mlflow.validate_required) = true];

Specified by:

getNameBytes in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The bytes for name.

setName

public ModelRegistry.TransitionModelVersionStage.Builder setName(String value)

 Name of the registered model
 

optional string name = 1 [(.mlflow.validate_required) = true];

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public ModelRegistry.TransitionModelVersionStage.Builder clearName()

 Name of the registered model
 

optional string name = 1 [(.mlflow.validate_required) = true];

Returns:

This builder for chaining.

setNameBytes

public ModelRegistry.TransitionModelVersionStage.Builder setNameBytes(com.google.protobuf.ByteString value)

 Name of the registered model
 

optional string name = 1 [(.mlflow.validate_required) = true];

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

hasVersion

public boolean hasVersion()

 Model version number
 

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

Specified by:

hasVersion in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

Whether the version field is set.

getVersion

public String getVersion()

 Model version number
 

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

Specified by:

getVersion in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The version.

getVersionBytes

public com.google.protobuf.ByteString getVersionBytes()

 Model version number
 

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

Specified by:

getVersionBytes in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The bytes for version.

setVersion

public ModelRegistry.TransitionModelVersionStage.Builder setVersion(String value)

 Model version number
 

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

Parameters:

value - The version to set.

Returns:

This builder for chaining.

clearVersion

public ModelRegistry.TransitionModelVersionStage.Builder clearVersion()

 Model version number
 

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

Returns:

This builder for chaining.

setVersionBytes

public ModelRegistry.TransitionModelVersionStage.Builder setVersionBytes(com.google.protobuf.ByteString value)

 Model version number
 

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

Parameters:

value - The bytes for version to set.

Returns:

This builder for chaining.

hasStage

public boolean hasStage()

 Transition `model_version` to new stage.
 

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

Specified by:

hasStage in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

Whether the stage field is set.

getStage

public String getStage()

 Transition `model_version` to new stage.
 

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

Specified by:

getStage in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The stage.

getStageBytes

public com.google.protobuf.ByteString getStageBytes()

 Transition `model_version` to new stage.
 

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

Specified by:

getStageBytes in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The bytes for stage.

setStage

public ModelRegistry.TransitionModelVersionStage.Builder setStage(String value)

 Transition `model_version` to new stage.
 

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

Parameters:

value - The stage to set.

Returns:

This builder for chaining.

clearStage

public ModelRegistry.TransitionModelVersionStage.Builder clearStage()

 Transition `model_version` to new stage.
 

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

Returns:

This builder for chaining.

setStageBytes

public ModelRegistry.TransitionModelVersionStage.Builder setStageBytes(com.google.protobuf.ByteString value)

 Transition `model_version` to new stage.
 

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

Parameters:

value - The bytes for stage to set.

Returns:

This builder for chaining.

hasArchiveExistingVersions

public boolean hasArchiveExistingVersions()

 When transitioning a model version to a particular stage, this flag dictates whether all
 existing model versions in that stage should be atomically moved to the "archived" stage.
 This ensures that at-most-one model version exists in the target stage.
 This field is *required* when transitioning a model versions's stage
 

optional bool archive_existing_versions = 4 [(.mlflow.validate_required) = true];

Specified by:

hasArchiveExistingVersions in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

Whether the archiveExistingVersions field is set.

getArchiveExistingVersions

public boolean getArchiveExistingVersions()

 When transitioning a model version to a particular stage, this flag dictates whether all
 existing model versions in that stage should be atomically moved to the "archived" stage.
 This ensures that at-most-one model version exists in the target stage.
 This field is *required* when transitioning a model versions's stage
 

optional bool archive_existing_versions = 4 [(.mlflow.validate_required) = true];

Specified by:

getArchiveExistingVersions in interface ModelRegistry.TransitionModelVersionStageOrBuilder

Returns:

The archiveExistingVersions.

setArchiveExistingVersions

public ModelRegistry.TransitionModelVersionStage.Builder setArchiveExistingVersions(boolean value)

 When transitioning a model version to a particular stage, this flag dictates whether all
 existing model versions in that stage should be atomically moved to the "archived" stage.
 This ensures that at-most-one model version exists in the target stage.
 This field is *required* when transitioning a model versions's stage
 

optional bool archive_existing_versions = 4 [(.mlflow.validate_required) = true];

Parameters:

value - The archiveExistingVersions to set.

Returns:

This builder for chaining.

clearArchiveExistingVersions

public ModelRegistry.TransitionModelVersionStage.Builder clearArchiveExistingVersions()

 When transitioning a model version to a particular stage, this flag dictates whether all
 existing model versions in that stage should be atomically moved to the "archived" stage.
 This ensures that at-most-one model version exists in the target stage.
 This field is *required* when transitioning a model versions's stage
 

optional bool archive_existing_versions = 4 [(.mlflow.validate_required) = true];

Returns:

This builder for chaining.

setUnknownFields

public final ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>

mergeUnknownFields

public final ModelRegistry.TransitionModelVersionStage.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<ModelRegistry.TransitionModelVersionStage.Builder>