Package org.mlflow.api.proto

Class ModelRegistry.ModelVersion

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.ModelRegistry.ModelVersion
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ModelRegistry.ModelVersionOrBuilder
Enclosing class:
ModelRegistry
public static final class ModelRegistry.ModelVersion extends com.google.protobuf.GeneratedMessageV3 implements ModelRegistry.ModelVersionOrBuilder
Protobuf type mlflow.ModelVersion
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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 of the model
      optional string name = 1;
      Specified by:
      hasName in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Unique name of the model
      optional string name = 1;
      Specified by:
      getName in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Unique name of the model
      optional string name = 1;
      Specified by:
      getNameBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for name.

    • hasVersion

      public boolean hasVersion()
       Model's version number.
      optional string version = 2;
      Specified by:
      hasVersion in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the version field is set.

    • getVersion

      public String getVersion()
       Model's version number.
      optional string version = 2;
      Specified by:
      getVersion in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The version.

    • getVersionBytes

      public com.google.protobuf.ByteString getVersionBytes()
       Model's version number.
      optional string version = 2;
      Specified by:
      getVersionBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for version.

    • hasCreationTimestamp

      public boolean hasCreationTimestamp()
       Timestamp recorded when this ``model_version`` was created.
      optional int64 creation_timestamp = 3;
      Specified by:
      hasCreationTimestamp in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      public long getCreationTimestamp()
       Timestamp recorded when this ``model_version`` was created.
      optional int64 creation_timestamp = 3;
      Specified by:
      getCreationTimestamp in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The creationTimestamp.

    • hasLastUpdatedTimestamp

      public boolean hasLastUpdatedTimestamp()
       Timestamp recorded when metadata for this ``model_version`` was last updated.
      optional int64 last_updated_timestamp = 4;
      Specified by:
      hasLastUpdatedTimestamp in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the lastUpdatedTimestamp field is set.

    • getLastUpdatedTimestamp

      public long getLastUpdatedTimestamp()
       Timestamp recorded when metadata for this ``model_version`` was last updated.
      optional int64 last_updated_timestamp = 4;
      Specified by:
      getLastUpdatedTimestamp in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The lastUpdatedTimestamp.

    • hasUserId

      public boolean hasUserId()
       User that created this ``model_version``.
      optional string user_id = 5;
      Specified by:
      hasUserId in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the userId field is set.

    • getUserId

      public String getUserId()
       User that created this ``model_version``.
      optional string user_id = 5;
      Specified by:
      getUserId in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The userId.

    • getUserIdBytes

      public com.google.protobuf.ByteString getUserIdBytes()
       User that created this ``model_version``.
      optional string user_id = 5;
      Specified by:
      getUserIdBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for userId.

    • hasCurrentStage

      public boolean hasCurrentStage()
       Current stage for this ``model_version``.
      optional string current_stage = 6;
      Specified by:
      hasCurrentStage in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the currentStage field is set.

    • getCurrentStage

      public String getCurrentStage()
       Current stage for this ``model_version``.
      optional string current_stage = 6;
      Specified by:
      getCurrentStage in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The currentStage.

    • getCurrentStageBytes

      public com.google.protobuf.ByteString getCurrentStageBytes()
       Current stage for this ``model_version``.
      optional string current_stage = 6;
      Specified by:
      getCurrentStageBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for currentStage.

    • hasDescription

      public boolean hasDescription()
       Description of this ``model_version``.
      optional string description = 7;
      Specified by:
      hasDescription in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
       Description of this ``model_version``.
      optional string description = 7;
      Specified by:
      getDescription in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of this ``model_version``.
      optional string description = 7;
      Specified by:
      getDescriptionBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for description.

    • hasSource

      public boolean hasSource()
       URI indicating the location of the source model artifacts, used when creating ``model_version``
      optional string source = 8;
      Specified by:
      hasSource in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the source field is set.

    • getSource

      public String getSource()
       URI indicating the location of the source model artifacts, used when creating ``model_version``
      optional string source = 8;
      Specified by:
      getSource in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The source.

    • getSourceBytes

      public com.google.protobuf.ByteString getSourceBytes()
       URI indicating the location of the source model artifacts, used when creating ``model_version``
      optional string source = 8;
      Specified by:
      getSourceBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for source.

    • hasRunId

      public boolean hasRunId()
       MLflow run ID used when creating ``model_version``, if ``source`` was generated by an
 experiment run stored in MLflow tracking server.
      optional string run_id = 9;
      Specified by:
      hasRunId in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the runId field is set.

    • getRunId

      public String getRunId()
       MLflow run ID used when creating ``model_version``, if ``source`` was generated by an
 experiment run stored in MLflow tracking server.
      optional string run_id = 9;
      Specified by:
      getRunId in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The runId.

    • getRunIdBytes

      public com.google.protobuf.ByteString getRunIdBytes()
       MLflow run ID used when creating ``model_version``, if ``source`` was generated by an
 experiment run stored in MLflow tracking server.
      optional string run_id = 9;
      Specified by:
      getRunIdBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for runId.

    • hasStatus

      public boolean hasStatus()
       Current status of ``model_version``
      optional .mlflow.ModelVersionStatus status = 10;
      Specified by:
      hasStatus in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public ModelRegistry.ModelVersionStatus getStatus()
       Current status of ``model_version``
      optional .mlflow.ModelVersionStatus status = 10;
      Specified by:
      getStatus in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The status.

    • hasStatusMessage

      public boolean hasStatusMessage()
       Details on current ``status``, if it is pending or failed.
      optional string status_message = 11;
      Specified by:
      hasStatusMessage in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the statusMessage field is set.

    • getStatusMessage

      public String getStatusMessage()
       Details on current ``status``, if it is pending or failed.
      optional string status_message = 11;
      Specified by:
      getStatusMessage in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The statusMessage.

    • getStatusMessageBytes

      public com.google.protobuf.ByteString getStatusMessageBytes()
       Details on current ``status``, if it is pending or failed.
      optional string status_message = 11;
      Specified by:
      getStatusMessageBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for statusMessage.

    • getTagsList

      public List<ModelRegistry.ModelVersionTag> getTagsList()
       Tags: Additional metadata key-value pairs for this ``model_version``.
      repeated .mlflow.ModelVersionTag tags = 12;
      Specified by:
      getTagsList in interface ModelRegistry.ModelVersionOrBuilder

    • getTagsOrBuilderList

      public List<? extends ModelRegistry.ModelVersionTagOrBuilder> getTagsOrBuilderList()
       Tags: Additional metadata key-value pairs for this ``model_version``.
      repeated .mlflow.ModelVersionTag tags = 12;
      Specified by:
      getTagsOrBuilderList in interface ModelRegistry.ModelVersionOrBuilder

    • getTagsCount

      public int getTagsCount()
       Tags: Additional metadata key-value pairs for this ``model_version``.
      repeated .mlflow.ModelVersionTag tags = 12;
      Specified by:
      getTagsCount in interface ModelRegistry.ModelVersionOrBuilder

    • getTags

      public ModelRegistry.ModelVersionTag getTags(int index)
       Tags: Additional metadata key-value pairs for this ``model_version``.
      repeated .mlflow.ModelVersionTag tags = 12;
      Specified by:
      getTags in interface ModelRegistry.ModelVersionOrBuilder

    • getTagsOrBuilder

      public ModelRegistry.ModelVersionTagOrBuilder getTagsOrBuilder(int index)
       Tags: Additional metadata key-value pairs for this ``model_version``.
      repeated .mlflow.ModelVersionTag tags = 12;
      Specified by:
      getTagsOrBuilder in interface ModelRegistry.ModelVersionOrBuilder

    • hasRunLink

      public boolean hasRunLink()
       Run Link: Direct link to the run that generated this version. This field is set at model version creation time
 only for model versions whose source run is from a tracking server that is different from the registry server.
      optional string run_link = 13;
      Specified by:
      hasRunLink in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the runLink field is set.

    • getRunLink

      public String getRunLink()
       Run Link: Direct link to the run that generated this version. This field is set at model version creation time
 only for model versions whose source run is from a tracking server that is different from the registry server.
      optional string run_link = 13;
      Specified by:
      getRunLink in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The runLink.

    • getRunLinkBytes

      public com.google.protobuf.ByteString getRunLinkBytes()
       Run Link: Direct link to the run that generated this version. This field is set at model version creation time
 only for model versions whose source run is from a tracking server that is different from the registry server.
      optional string run_link = 13;
      Specified by:
      getRunLinkBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for runLink.

    • getAliasesList

      public com.google.protobuf.ProtocolStringList getAliasesList()
       Aliases pointing to this ``model_version``.
      repeated string aliases = 14;
      Specified by:
      getAliasesList in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      A list containing the aliases.

    • getAliasesCount

      public int getAliasesCount()
       Aliases pointing to this ``model_version``.
      repeated string aliases = 14;
      Specified by:
      getAliasesCount in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The count of aliases.

    • getAliases

      public String getAliases(int index)
       Aliases pointing to this ``model_version``.
      repeated string aliases = 14;
      Specified by:
      getAliases in interface ModelRegistry.ModelVersionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The aliases at the given index.

    • getAliasesBytes

      public com.google.protobuf.ByteString getAliasesBytes(int index)
       Aliases pointing to this ``model_version``.
      repeated string aliases = 14;
      Specified by:
      getAliasesBytes in interface ModelRegistry.ModelVersionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the aliases at the given index.

    • hasModelId

      public boolean hasModelId()
       Optional `model_id` for model version that is used to link the registered model to the source logged model
      optional string model_id = 15;
      Specified by:
      hasModelId in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the modelId field is set.

    • getModelId

      public String getModelId()
       Optional `model_id` for model version that is used to link the registered model to the source logged model
      optional string model_id = 15;
      Specified by:
      getModelId in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The modelId.

    • getModelIdBytes

      public com.google.protobuf.ByteString getModelIdBytes()
       Optional `model_id` for model version that is used to link the registered model to the source logged model
      optional string model_id = 15;
      Specified by:
      getModelIdBytes in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The bytes for modelId.

    • getModelParamsList

      public List<ModelRegistry.ModelParam> getModelParamsList()
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 16;
      Specified by:
      getModelParamsList in interface ModelRegistry.ModelVersionOrBuilder

    • getModelParamsOrBuilderList

      public List<? extends ModelRegistry.ModelParamOrBuilder> getModelParamsOrBuilderList()
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 16;
      Specified by:
      getModelParamsOrBuilderList in interface ModelRegistry.ModelVersionOrBuilder

    • getModelParamsCount

      public int getModelParamsCount()
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 16;
      Specified by:
      getModelParamsCount in interface ModelRegistry.ModelVersionOrBuilder

    • getModelParams

      public ModelRegistry.ModelParam getModelParams(int index)
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 16;
      Specified by:
      getModelParams in interface ModelRegistry.ModelVersionOrBuilder

    • getModelParamsOrBuilder

      public ModelRegistry.ModelParamOrBuilder getModelParamsOrBuilder(int index)
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 16;
      Specified by:
      getModelParamsOrBuilder in interface ModelRegistry.ModelVersionOrBuilder

    • getModelMetricsList

      public List<ModelRegistry.ModelMetric> getModelMetricsList()
       Optional metrics for the model.
      repeated .mlflow.ModelMetric model_metrics = 17;
      Specified by:
      getModelMetricsList in interface ModelRegistry.ModelVersionOrBuilder

    • getModelMetricsOrBuilderList

      public List<? extends ModelRegistry.ModelMetricOrBuilder> getModelMetricsOrBuilderList()
       Optional metrics for the model.
      repeated .mlflow.ModelMetric model_metrics = 17;
      Specified by:
      getModelMetricsOrBuilderList in interface ModelRegistry.ModelVersionOrBuilder

    • getModelMetricsCount

      public int getModelMetricsCount()
       Optional metrics for the model.
      repeated .mlflow.ModelMetric model_metrics = 17;
      Specified by:
      getModelMetricsCount in interface ModelRegistry.ModelVersionOrBuilder

    • getModelMetrics

      public ModelRegistry.ModelMetric getModelMetrics(int index)
       Optional metrics for the model.
      repeated .mlflow.ModelMetric model_metrics = 17;
      Specified by:
      getModelMetrics in interface ModelRegistry.ModelVersionOrBuilder

    • getModelMetricsOrBuilder

      public ModelRegistry.ModelMetricOrBuilder getModelMetricsOrBuilder(int index)
       Optional metrics for the model.
      repeated .mlflow.ModelMetric model_metrics = 17;
      Specified by:
      getModelMetricsOrBuilder in interface ModelRegistry.ModelVersionOrBuilder

    • hasDeploymentJobState

      public boolean hasDeploymentJobState()
       Deployment job state for this model version.
      optional .mlflow.ModelVersionDeploymentJobState deployment_job_state = 19;
      Specified by:
      hasDeploymentJobState in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      Whether the deploymentJobState field is set.

    • getDeploymentJobState

      public ModelRegistry.ModelVersionDeploymentJobState getDeploymentJobState()
       Deployment job state for this model version.
      optional .mlflow.ModelVersionDeploymentJobState deployment_job_state = 19;
      Specified by:
      getDeploymentJobState in interface ModelRegistry.ModelVersionOrBuilder
      Returns:
      The deploymentJobState.

    • getDeploymentJobStateOrBuilder

      public ModelRegistry.ModelVersionDeploymentJobStateOrBuilder getDeploymentJobStateOrBuilder()
       Deployment job state for this model version.
      optional .mlflow.ModelVersionDeploymentJobState deployment_job_state = 19;
      Specified by:
      getDeploymentJobStateOrBuilder in interface ModelRegistry.ModelVersionOrBuilder

    • 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.ModelVersion parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ModelRegistry.ModelVersion parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelRegistry.ModelVersion 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.ModelVersion parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static ModelRegistry.ModelVersion parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ModelRegistry.ModelVersion parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ModelRegistry.ModelVersion parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public ModelRegistry.ModelVersion.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ModelRegistry.ModelVersion.Builder newBuilder()

    • newBuilder

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

    • toBuilder

      public ModelRegistry.ModelVersion.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ModelRegistry.ModelVersion.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ModelRegistry.ModelVersion getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ModelRegistry.ModelVersion> 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.ModelVersion getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder