Package 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typemlflow.RegisteredModelNested 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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final com.google.protobuf.Parser<ModelRegistry.RegisteredModel>Deprecated.static final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleangetAliases(int index) Aliases pointing to model versions associated with this ``registered_model``.intAliases pointing to model versions associated with this ``registered_model``.Aliases pointing to model versions associated with this ``registered_model``.getAliasesOrBuilder(int index) Aliases pointing to model versions associated with this ``registered_model``.List<? extends ModelRegistry.RegisteredModelAliasOrBuilder>Aliases pointing to model versions associated with this ``registered_model``.longTimestamp recorded when this ``registered_model`` was created.Deployment job id for this model.com.google.protobuf.ByteStringDeployment job id for this model.Deployment job state for this model.Description of this ``registered_model``.com.google.protobuf.ByteStringDescription of this ``registered_model``.static final com.google.protobuf.Descriptors.DescriptorlongTimestamp recorded when metadata for this ``registered_model`` was last updated.getLatestVersions(int index) Collection of latest model versions for each stage.intCollection of latest model versions for each stage.Collection of latest model versions for each stage.getLatestVersionsOrBuilder(int index) Collection of latest model versions for each stage.List<? extends ModelRegistry.ModelVersionOrBuilder>Collection of latest model versions for each stage.getName()Unique name for the model.com.google.protobuf.ByteStringUnique name for the model.com.google.protobuf.Parser<ModelRegistry.RegisteredModel>intgetTags(int index) Tags: Additional metadata key-value pairs for this ``registered_model``.intTags: Additional metadata key-value pairs for this ``registered_model``.Tags: Additional metadata key-value pairs for this ``registered_model``.getTagsOrBuilder(int index) Tags: Additional metadata key-value pairs for this ``registered_model``.List<? extends ModelRegistry.RegisteredModelTagOrBuilder>Tags: Additional metadata key-value pairs for this ``registered_model``.final com.google.protobuf.UnknownFieldSetUser that created this ``registered_model`` NOTE: this field is not currently returned.com.google.protobuf.ByteStringUser that created this ``registered_model`` NOTE: this field is not currently returned.booleanTimestamp recorded when this ``registered_model`` was created.booleanDeployment job id for this model.booleanDeployment job state for this model.booleanDescription of this ``registered_model``.inthashCode()booleanTimestamp recorded when metadata for this ``registered_model`` was last updated.booleanhasName()Unique name for the model.booleanUser that created this ``registered_model`` NOTE: this field is not currently returned.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(ModelRegistry.RegisteredModel prototype) protected ModelRegistry.RegisteredModel.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ModelRegistry.RegisteredModel>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER- See Also:
-
LAST_UPDATED_TIMESTAMP_FIELD_NUMBER
public static final int LAST_UPDATED_TIMESTAMP_FIELD_NUMBER- See Also:
-
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
LATEST_VERSIONS_FIELD_NUMBER
public static final int LATEST_VERSIONS_FIELD_NUMBER- See Also:
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
ALIASES_FIELD_NUMBER
public static final int ALIASES_FIELD_NUMBER- See Also:
-
DEPLOYMENT_JOB_ID_FIELD_NUMBER
public static final int DEPLOYMENT_JOB_ID_FIELD_NUMBER- See Also:
-
DEPLOYMENT_JOB_STATE_FIELD_NUMBER
public static final int DEPLOYMENT_JOB_STATE_FIELD_NUMBER- See Also:
-
PARSER
Deprecated.
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasName
public boolean hasName()Unique name for the model.
optional string name = 1;- Specified by:
hasNamein interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the name field is set.
-
getName
Unique name for the model.
optional string name = 1;- Specified by:
getNamein interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Unique name for the model.
optional string name = 1;- Specified by:
getNameBytesin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The bytes for name.
-
hasCreationTimestamp
public boolean hasCreationTimestamp()Timestamp recorded when this ``registered_model`` was created.
optional int64 creation_timestamp = 2;- Specified by:
hasCreationTimestampin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
public long getCreationTimestamp()Timestamp recorded when this ``registered_model`` was created.
optional int64 creation_timestamp = 2;- Specified by:
getCreationTimestampin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The creationTimestamp.
-
hasLastUpdatedTimestamp
public boolean hasLastUpdatedTimestamp()Timestamp recorded when metadata for this ``registered_model`` was last updated.
optional int64 last_updated_timestamp = 3;- Specified by:
hasLastUpdatedTimestampin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the lastUpdatedTimestamp field is set.
-
getLastUpdatedTimestamp
public long getLastUpdatedTimestamp()Timestamp recorded when metadata for this ``registered_model`` was last updated.
optional int64 last_updated_timestamp = 3;- Specified by:
getLastUpdatedTimestampin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The lastUpdatedTimestamp.
-
hasUserId
public boolean hasUserId()User that created this ``registered_model`` NOTE: this field is not currently returned.
optional string user_id = 4;- Specified by:
hasUserIdin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the userId field is set.
-
getUserId
User that created this ``registered_model`` NOTE: this field is not currently returned.
optional string user_id = 4;- Specified by:
getUserIdin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The userId.
-
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:
getUserIdBytesin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The bytes for userId.
-
hasDescription
public boolean hasDescription()Description of this ``registered_model``.
optional string description = 5;- Specified by:
hasDescriptionin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the description field is set.
-
getDescription
Description of this ``registered_model``.
optional string description = 5;- Specified by:
getDescriptionin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()Description of this ``registered_model``.
optional string description = 5;- Specified by:
getDescriptionBytesin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The bytes for description.
-
getLatestVersionsList
Collection of latest model versions for each stage. Only contains models with current ``READY`` status.
repeated .mlflow.ModelVersion latest_versions = 6;- Specified by:
getLatestVersionsListin interfaceModelRegistry.RegisteredModelOrBuilder
-
getLatestVersionsOrBuilderList
Collection of latest model versions for each stage. Only contains models with current ``READY`` status.
repeated .mlflow.ModelVersion latest_versions = 6;- Specified by:
getLatestVersionsOrBuilderListin interfaceModelRegistry.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:
getLatestVersionsCountin interfaceModelRegistry.RegisteredModelOrBuilder
-
getLatestVersions
Collection of latest model versions for each stage. Only contains models with current ``READY`` status.
repeated .mlflow.ModelVersion latest_versions = 6;- Specified by:
getLatestVersionsin interfaceModelRegistry.RegisteredModelOrBuilder
-
getLatestVersionsOrBuilder
Collection of latest model versions for each stage. Only contains models with current ``READY`` status.
repeated .mlflow.ModelVersion latest_versions = 6;- Specified by:
getLatestVersionsOrBuilderin interfaceModelRegistry.RegisteredModelOrBuilder
-
getTagsList
Tags: Additional metadata key-value pairs for this ``registered_model``.
repeated .mlflow.RegisteredModelTag tags = 7;- Specified by:
getTagsListin interfaceModelRegistry.RegisteredModelOrBuilder
-
getTagsOrBuilderList
Tags: Additional metadata key-value pairs for this ``registered_model``.
repeated .mlflow.RegisteredModelTag tags = 7;- Specified by:
getTagsOrBuilderListin interfaceModelRegistry.RegisteredModelOrBuilder
-
getTagsCount
public int getTagsCount()Tags: Additional metadata key-value pairs for this ``registered_model``.
repeated .mlflow.RegisteredModelTag tags = 7;- Specified by:
getTagsCountin interfaceModelRegistry.RegisteredModelOrBuilder
-
getTags
Tags: Additional metadata key-value pairs for this ``registered_model``.
repeated .mlflow.RegisteredModelTag tags = 7;- Specified by:
getTagsin interfaceModelRegistry.RegisteredModelOrBuilder
-
getTagsOrBuilder
Tags: Additional metadata key-value pairs for this ``registered_model``.
repeated .mlflow.RegisteredModelTag tags = 7;- Specified by:
getTagsOrBuilderin interfaceModelRegistry.RegisteredModelOrBuilder
-
getAliasesList
Aliases pointing to model versions associated with this ``registered_model``.
repeated .mlflow.RegisteredModelAlias aliases = 8;- Specified by:
getAliasesListin interfaceModelRegistry.RegisteredModelOrBuilder
-
getAliasesOrBuilderList
Aliases pointing to model versions associated with this ``registered_model``.
repeated .mlflow.RegisteredModelAlias aliases = 8;- Specified by:
getAliasesOrBuilderListin interfaceModelRegistry.RegisteredModelOrBuilder
-
getAliasesCount
public int getAliasesCount()Aliases pointing to model versions associated with this ``registered_model``.
repeated .mlflow.RegisteredModelAlias aliases = 8;- Specified by:
getAliasesCountin interfaceModelRegistry.RegisteredModelOrBuilder
-
getAliases
Aliases pointing to model versions associated with this ``registered_model``.
repeated .mlflow.RegisteredModelAlias aliases = 8;- Specified by:
getAliasesin interfaceModelRegistry.RegisteredModelOrBuilder
-
getAliasesOrBuilder
Aliases pointing to model versions associated with this ``registered_model``.
repeated .mlflow.RegisteredModelAlias aliases = 8;- Specified by:
getAliasesOrBuilderin interfaceModelRegistry.RegisteredModelOrBuilder
-
hasDeploymentJobId
public boolean hasDeploymentJobId()Deployment job id for this model.
optional string deployment_job_id = 9;- Specified by:
hasDeploymentJobIdin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the deploymentJobId field is set.
-
getDeploymentJobId
Deployment job id for this model.
optional string deployment_job_id = 9;- Specified by:
getDeploymentJobIdin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The deploymentJobId.
-
getDeploymentJobIdBytes
public com.google.protobuf.ByteString getDeploymentJobIdBytes()Deployment job id for this model.
optional string deployment_job_id = 9;- Specified by:
getDeploymentJobIdBytesin interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The bytes for deploymentJobId.
-
hasDeploymentJobState
public boolean hasDeploymentJobState()Deployment job state for this model.
optional .mlflow.DeploymentJobConnection.State deployment_job_state = 10;- Specified by:
hasDeploymentJobStatein interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- Whether the deploymentJobState field is set.
-
getDeploymentJobState
Deployment job state for this model.
optional .mlflow.DeploymentJobConnection.State deployment_job_state = 10;- Specified by:
getDeploymentJobStatein interfaceModelRegistry.RegisteredModelOrBuilder- Returns:
- The deploymentJobState.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static ModelRegistry.RegisteredModel.Builder newBuilder(ModelRegistry.RegisteredModel prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ModelRegistry.RegisteredModel.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-