org.mlflow.api.proto

Class ModelRegistry.RegisteredModel

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.ModelRegistry.RegisteredModel

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ModelRegistry.RegisteredModelOrBuilder

Enclosing class:

ModelRegistry

public static final class ModelRegistry.RegisteredModel
extends com.google.protobuf.GeneratedMessageV3
implements ModelRegistry.RegisteredModelOrBuilder

Protobuf type mlflow.RegisteredModel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelRegistry.RegisteredModel.Builder Protobuf type mlflow.RegisteredModel

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATION_TIMESTAMP_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	LAST_UPDATED_TIMESTAMP_FIELD_NUMBER
static int	LATEST_VERSIONS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static com.google.protobuf.Parser<ModelRegistry.RegisteredModel>	PARSER Deprecated.
static int	TAGS_FIELD_NUMBER
static int	USER_ID_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 and Description
boolean	equals(Object obj)
long	getCreationTimestamp() Timestamp recorded when this ``registered_model`` was created.
static ModelRegistry.RegisteredModel	getDefaultInstance()
ModelRegistry.RegisteredModel	getDefaultInstanceForType()
String	getDescription() Description of this ``registered_model``.
com.google.protobuf.ByteString	getDescriptionBytes() Description of this ``registered_model``.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getLastUpdatedTimestamp() Timestamp recorded when metadata for this ``registered_model`` was last updated.
ModelRegistry.ModelVersion	getLatestVersions(int index) Collection of latest model versions for each stage.
int	getLatestVersionsCount() Collection of latest model versions for each stage.
List<ModelRegistry.ModelVersion>	getLatestVersionsList() Collection of latest model versions for each stage.
ModelRegistry.ModelVersionOrBuilder	getLatestVersionsOrBuilder(int index) Collection of latest model versions for each stage.
List<? extends ModelRegistry.ModelVersionOrBuilder>	getLatestVersionsOrBuilderList() Collection of latest model versions for each stage.
String	getName() Unique name for the model.
com.google.protobuf.ByteString	getNameBytes() Unique name for the model.
com.google.protobuf.Parser<ModelRegistry.RegisteredModel>	getParserForType()
int	getSerializedSize()
ModelRegistry.RegisteredModelTag	getTags(int index) Tags: Additional metadata key-value pairs for this ``registered_model``.
int	getTagsCount() Tags: Additional metadata key-value pairs for this ``registered_model``.
List<ModelRegistry.RegisteredModelTag>	getTagsList() Tags: Additional metadata key-value pairs for this ``registered_model``.
ModelRegistry.RegisteredModelTagOrBuilder	getTagsOrBuilder(int index) Tags: Additional metadata key-value pairs for this ``registered_model``.
List<? extends ModelRegistry.RegisteredModelTagOrBuilder>	getTagsOrBuilderList() Tags: Additional metadata key-value pairs for this ``registered_model``.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getUserId() User that created this ``registered_model`` NOTE: this field is not currently returned.
com.google.protobuf.ByteString	getUserIdBytes() User that created this ``registered_model`` NOTE: this field is not currently returned.
boolean	hasCreationTimestamp() Timestamp recorded when this ``registered_model`` was created.
boolean	hasDescription() Description of this ``registered_model``.
int	hashCode()
boolean	hasLastUpdatedTimestamp() Timestamp recorded when metadata for this ``registered_model`` was last updated.
boolean	hasName() Unique name for the model.
boolean	hasUserId() User that created this ``registered_model`` NOTE: this field is not currently returned.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ModelRegistry.RegisteredModel.Builder	newBuilder()
static ModelRegistry.RegisteredModel.Builder	newBuilder(ModelRegistry.RegisteredModel prototype)
ModelRegistry.RegisteredModel.Builder	newBuilderForType()
protected ModelRegistry.RegisteredModel.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static ModelRegistry.RegisteredModel	parseDelimitedFrom(InputStream input)
static ModelRegistry.RegisteredModel	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.RegisteredModel	parseFrom(byte[] data)
static ModelRegistry.RegisteredModel	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.RegisteredModel	parseFrom(ByteBuffer data)
static ModelRegistry.RegisteredModel	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.RegisteredModel	parseFrom(com.google.protobuf.ByteString data)
static ModelRegistry.RegisteredModel	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.RegisteredModel	parseFrom(com.google.protobuf.CodedInputStream input)
static ModelRegistry.RegisteredModel	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ModelRegistry.RegisteredModel	parseFrom(InputStream input)
static ModelRegistry.RegisteredModel	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ModelRegistry.RegisteredModel>	parser()
ModelRegistry.RegisteredModel.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

LAST_UPDATED_TIMESTAMP_FIELD_NUMBER

public static final int LAST_UPDATED_TIMESTAMP_FIELD_NUMBER

See Also:

Constant Field Values

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

LATEST_VERSIONS_FIELD_NUMBER

public static final int LATEST_VERSIONS_FIELD_NUMBER

See Also:

Constant Field Values

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<ModelRegistry.RegisteredModel> PARSER

Deprecated.

Method Detail

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

hasName

public boolean hasName()

 Unique name for the model.
 

optional string name = 1;

Specified by:

hasName in interface ModelRegistry.RegisteredModelOrBuilder

getName

public String getName()

 Unique name for the model.
 

optional string name = 1;

Specified by:

getName in interface ModelRegistry.RegisteredModelOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Unique name for the model.
 

optional string name = 1;

Specified by:

getNameBytes in interface ModelRegistry.RegisteredModelOrBuilder

hasCreationTimestamp

public boolean hasCreationTimestamp()

 Timestamp recorded when this ``registered_model`` was created.
 

optional int64 creation_timestamp = 2;

Specified by:

hasCreationTimestamp in interface ModelRegistry.RegisteredModelOrBuilder

getCreationTimestamp

public long getCreationTimestamp()

 Timestamp recorded when this ``registered_model`` was created.
 

optional int64 creation_timestamp = 2;

Specified by:

getCreationTimestamp in interface ModelRegistry.RegisteredModelOrBuilder

hasLastUpdatedTimestamp

public boolean hasLastUpdatedTimestamp()

 Timestamp recorded when metadata for this ``registered_model`` was last updated.
 

optional int64 last_updated_timestamp = 3;

Specified by:

hasLastUpdatedTimestamp in interface ModelRegistry.RegisteredModelOrBuilder

getLastUpdatedTimestamp

public long getLastUpdatedTimestamp()

 Timestamp recorded when metadata for this ``registered_model`` was last updated.
 

optional int64 last_updated_timestamp = 3;

Specified by:

getLastUpdatedTimestamp in interface ModelRegistry.RegisteredModelOrBuilder

hasUserId

public boolean hasUserId()

 User that created this ``registered_model``
 NOTE: this field is not currently returned.
 

optional string user_id = 4;

Specified by:

hasUserId in interface ModelRegistry.RegisteredModelOrBuilder

getUserId

public String getUserId()

 User that created this ``registered_model``
 NOTE: this field is not currently returned.
 

optional string user_id = 4;

Specified by:

getUserId in interface ModelRegistry.RegisteredModelOrBuilder

getUserIdBytes

public com.google.protobuf.ByteString getUserIdBytes()

 User that created this ``registered_model``
 NOTE: this field is not currently returned.
 

optional string user_id = 4;

Specified by:

getUserIdBytes in interface ModelRegistry.RegisteredModelOrBuilder

hasDescription

public boolean hasDescription()

 Description of this ``registered_model``.
 

optional string description = 5;

Specified by:

hasDescription in interface ModelRegistry.RegisteredModelOrBuilder

getDescription

public String getDescription()

 Description of this ``registered_model``.
 

optional string description = 5;

Specified by:

getDescription in interface ModelRegistry.RegisteredModelOrBuilder

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of this ``registered_model``.
 

optional string description = 5;

Specified by:

getDescriptionBytes in interface ModelRegistry.RegisteredModelOrBuilder

getLatestVersionsList

public List<ModelRegistry.ModelVersion> getLatestVersionsList()

 Collection of latest model versions for each stage.
 Only contains models with current ``READY`` status.
 

repeated .mlflow.ModelVersion latest_versions = 6;

Specified by:

getLatestVersionsList in interface ModelRegistry.RegisteredModelOrBuilder

getLatestVersionsOrBuilderList

public List<? extends ModelRegistry.ModelVersionOrBuilder> getLatestVersionsOrBuilderList()

 Collection of latest model versions for each stage.
 Only contains models with current ``READY`` status.
 

repeated .mlflow.ModelVersion latest_versions = 6;

Specified by:

getLatestVersionsOrBuilderList in interface ModelRegistry.RegisteredModelOrBuilder

getLatestVersionsCount

public int getLatestVersionsCount()

 Collection of latest model versions for each stage.
 Only contains models with current ``READY`` status.
 

repeated .mlflow.ModelVersion latest_versions = 6;

Specified by:

getLatestVersionsCount in interface ModelRegistry.RegisteredModelOrBuilder

getLatestVersions

public ModelRegistry.ModelVersion getLatestVersions(int index)

 Collection of latest model versions for each stage.
 Only contains models with current ``READY`` status.
 

repeated .mlflow.ModelVersion latest_versions = 6;

Specified by:

getLatestVersions in interface ModelRegistry.RegisteredModelOrBuilder

getLatestVersionsOrBuilder

public ModelRegistry.ModelVersionOrBuilder getLatestVersionsOrBuilder(int index)

 Collection of latest model versions for each stage.
 Only contains models with current ``READY`` status.
 

repeated .mlflow.ModelVersion latest_versions = 6;

Specified by:

getLatestVersionsOrBuilder in interface ModelRegistry.RegisteredModelOrBuilder

getTagsList

public List<ModelRegistry.RegisteredModelTag> getTagsList()

 Tags: Additional metadata key-value pairs for this ``registered_model``.
 

repeated .mlflow.RegisteredModelTag tags = 7;

Specified by:

getTagsList in interface ModelRegistry.RegisteredModelOrBuilder

getTagsOrBuilderList

public List<? extends ModelRegistry.RegisteredModelTagOrBuilder> getTagsOrBuilderList()

 Tags: Additional metadata key-value pairs for this ``registered_model``.
 

repeated .mlflow.RegisteredModelTag tags = 7;

Specified by:

getTagsOrBuilderList in interface ModelRegistry.RegisteredModelOrBuilder

getTagsCount

public int getTagsCount()

 Tags: Additional metadata key-value pairs for this ``registered_model``.
 

repeated .mlflow.RegisteredModelTag tags = 7;

Specified by:

getTagsCount in interface ModelRegistry.RegisteredModelOrBuilder

getTags

public ModelRegistry.RegisteredModelTag getTags(int index)

 Tags: Additional metadata key-value pairs for this ``registered_model``.
 

repeated .mlflow.RegisteredModelTag tags = 7;

Specified by:

getTags in interface ModelRegistry.RegisteredModelOrBuilder

getTagsOrBuilder

public ModelRegistry.RegisteredModelTagOrBuilder getTagsOrBuilder(int index)

 Tags: Additional metadata key-value pairs for this ``registered_model``.
 

repeated .mlflow.RegisteredModelTag tags = 7;

Specified by:

getTagsOrBuilder in interface ModelRegistry.RegisteredModelOrBuilder

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 ModelRegistry.RegisteredModel parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static ModelRegistry.RegisteredModel parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static ModelRegistry.RegisteredModel parseDelimitedFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static ModelRegistry.RegisteredModel parseFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public ModelRegistry.RegisteredModel.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ModelRegistry.RegisteredModel.Builder newBuilder()

newBuilder

public static ModelRegistry.RegisteredModel.Builder newBuilder(ModelRegistry.RegisteredModel prototype)

toBuilder

public ModelRegistry.RegisteredModel.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ModelRegistry.RegisteredModel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ModelRegistry.RegisteredModel getDefaultInstance()

parser

public static com.google.protobuf.Parser<ModelRegistry.RegisteredModel> parser()

getParserForType

public com.google.protobuf.Parser<ModelRegistry.RegisteredModel> 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 ModelRegistry.RegisteredModel getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder