Package org.mlflow.api.proto

Interface ModelRegistry.ModelVersionOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAliases​(int index)
      Aliases pointing to this ``model_version``.
      com.google.protobuf.ByteString getAliasesBytes​(int index)
      Aliases pointing to this ``model_version``.
      int getAliasesCount()
      Aliases pointing to this ``model_version``.
      java.util.List<java.lang.String> getAliasesList()
      Aliases pointing to this ``model_version``.
      long getCreationTimestamp()
      Timestamp recorded when this ``model_version`` was created.
      java.lang.String getCurrentStage()
      Current stage for this ``model_version``.
      com.google.protobuf.ByteString getCurrentStageBytes()
      Current stage for this ``model_version``.
      java.lang.String getDescription()
      Description of this ``model_version``.
      com.google.protobuf.ByteString getDescriptionBytes()
      Description of this ``model_version``.
      long getLastUpdatedTimestamp()
      Timestamp recorded when metadata for this ``model_version`` was last updated.
      java.lang.String getName()
      Unique name of the model
      com.google.protobuf.ByteString getNameBytes()
      Unique name of the model
      java.lang.String getRunId()
      MLflow run ID used when creating ``model_version``, if ``source`` was generated by an experiment run stored in MLflow tracking server.
      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.
      java.lang.String getRunLink()
      Run Link: Direct link to the run that generated this version.
      com.google.protobuf.ByteString getRunLinkBytes()
      Run Link: Direct link to the run that generated this version.
      java.lang.String getSource()
      URI indicating the location of the source model artifacts, used when creating ``model_version``
      com.google.protobuf.ByteString getSourceBytes()
      URI indicating the location of the source model artifacts, used when creating ``model_version``
      ModelRegistry.ModelVersionStatus getStatus()
      Current status of ``model_version``
      java.lang.String getStatusMessage()
      Details on current ``status``, if it is pending or failed.
      com.google.protobuf.ByteString getStatusMessageBytes()
      Details on current ``status``, if it is pending or failed.
      ModelRegistry.ModelVersionTag getTags​(int index)
      Tags: Additional metadata key-value pairs for this ``model_version``.
      int getTagsCount()
      Tags: Additional metadata key-value pairs for this ``model_version``.
      java.util.List<ModelRegistry.ModelVersionTag> getTagsList()
      Tags: Additional metadata key-value pairs for this ``model_version``.
      ModelRegistry.ModelVersionTagOrBuilder getTagsOrBuilder​(int index)
      Tags: Additional metadata key-value pairs for this ``model_version``.
      java.util.List<? extends ModelRegistry.ModelVersionTagOrBuilder> getTagsOrBuilderList()
      Tags: Additional metadata key-value pairs for this ``model_version``.
      java.lang.String getUserId()
      User that created this ``model_version``.
      com.google.protobuf.ByteString getUserIdBytes()
      User that created this ``model_version``.
      java.lang.String getVersion()
      Model's version number.
      com.google.protobuf.ByteString getVersionBytes()
      Model's version number.
      boolean hasCreationTimestamp()
      Timestamp recorded when this ``model_version`` was created.
      boolean hasCurrentStage()
      Current stage for this ``model_version``.
      boolean hasDescription()
      Description of this ``model_version``.
      boolean hasLastUpdatedTimestamp()
      Timestamp recorded when metadata for this ``model_version`` was last updated.
      boolean hasName()
      Unique name of the model
      boolean hasRunId()
      MLflow run ID used when creating ``model_version``, if ``source`` was generated by an experiment run stored in MLflow tracking server.
      boolean hasRunLink()
      Run Link: Direct link to the run that generated this version.
      boolean hasSource()
      URI indicating the location of the source model artifacts, used when creating ``model_version``
      boolean hasStatus()
      Current status of ``model_version``
      boolean hasStatusMessage()
      Details on current ``status``, if it is pending or failed.
      boolean hasUserId()
      User that created this ``model_version``.
      boolean hasVersion()
      Model's version number.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasName

        boolean hasName()
         Unique name of the model
        optional string name = 1;
        Returns:
        Whether the name field is set.

      • getName

        java.lang.String getName()
         Unique name of the model
        optional string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Unique name of the model
        optional string name = 1;
        Returns:
        The bytes for name.

      • hasVersion

        boolean hasVersion()
         Model's version number.
        optional string version = 2;
        Returns:
        Whether the version field is set.

      • getVersion

        java.lang.String getVersion()
         Model's version number.
        optional string version = 2;
        Returns:
        The version.

      • getVersionBytes

        com.google.protobuf.ByteString getVersionBytes()
         Model's version number.
        optional string version = 2;
        Returns:
        The bytes for version.

      • hasCreationTimestamp

        boolean hasCreationTimestamp()
         Timestamp recorded when this ``model_version`` was created.
        optional int64 creation_timestamp = 3;
        Returns:
        Whether the creationTimestamp field is set.

      • getCreationTimestamp

        long getCreationTimestamp()
         Timestamp recorded when this ``model_version`` was created.
        optional int64 creation_timestamp = 3;
        Returns:
        The creationTimestamp.

      • hasLastUpdatedTimestamp

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

      • getLastUpdatedTimestamp

        long getLastUpdatedTimestamp()
         Timestamp recorded when metadata for this ``model_version`` was last updated.
        optional int64 last_updated_timestamp = 4;
        Returns:
        The lastUpdatedTimestamp.

      • hasUserId

        boolean hasUserId()
         User that created this ``model_version``.
        optional string user_id = 5;
        Returns:
        Whether the userId field is set.

      • getUserId

        java.lang.String getUserId()
         User that created this ``model_version``.
        optional string user_id = 5;
        Returns:
        The userId.

      • getUserIdBytes

        com.google.protobuf.ByteString getUserIdBytes()
         User that created this ``model_version``.
        optional string user_id = 5;
        Returns:
        The bytes for userId.

      • hasCurrentStage

        boolean hasCurrentStage()
         Current stage for this ``model_version``.
        optional string current_stage = 6;
        Returns:
        Whether the currentStage field is set.

      • getCurrentStage

        java.lang.String getCurrentStage()
         Current stage for this ``model_version``.
        optional string current_stage = 6;
        Returns:
        The currentStage.

      • getCurrentStageBytes

        com.google.protobuf.ByteString getCurrentStageBytes()
         Current stage for this ``model_version``.
        optional string current_stage = 6;
        Returns:
        The bytes for currentStage.

      • hasDescription

        boolean hasDescription()
         Description of this ``model_version``.
        optional string description = 7;
        Returns:
        Whether the description field is set.

      • getDescription

        java.lang.String getDescription()
         Description of this ``model_version``.
        optional string description = 7;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Description of this ``model_version``.
        optional string description = 7;
        Returns:
        The bytes for description.

      • hasSource

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

      • getSource

        java.lang.String getSource()
         URI indicating the location of the source model artifacts, used when creating ``model_version``
        optional string source = 8;
        Returns:
        The source.

      • getSourceBytes

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

      • hasRunId

        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;
        Returns:
        Whether the runId field is set.

      • getRunId

        java.lang.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;
        Returns:
        The runId.

      • getRunIdBytes

        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;
        Returns:
        The bytes for runId.

      • hasStatus

        boolean hasStatus()
         Current status of ``model_version``
        optional .mlflow.ModelVersionStatus status = 10;
        Returns:
        Whether the status field is set.

      • getStatus

        ModelRegistry.ModelVersionStatus getStatus()
         Current status of ``model_version``
        optional .mlflow.ModelVersionStatus status = 10;
        Returns:
        The status.

      • hasStatusMessage

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

      • getStatusMessage

        java.lang.String getStatusMessage()
         Details on current ``status``, if it is pending or failed.
        optional string status_message = 11;
        Returns:
        The statusMessage.

      • getStatusMessageBytes

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

      • getTagsList

        java.util.List<ModelRegistry.ModelVersionTag> getTagsList()
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • getTags

        ModelRegistry.ModelVersionTag getTags​(int index)
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • getTagsCount

        int getTagsCount()
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • getTagsOrBuilderList

        java.util.List<? extends ModelRegistry.ModelVersionTagOrBuilder> getTagsOrBuilderList()
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • getTagsOrBuilder

        ModelRegistry.ModelVersionTagOrBuilder getTagsOrBuilder​(int index)
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • hasRunLink

        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;
        Returns:
        Whether the runLink field is set.

      • getRunLink

        java.lang.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;
        Returns:
        The runLink.

      • getRunLinkBytes

        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;
        Returns:
        The bytes for runLink.

      • getAliasesList

        java.util.List<java.lang.String> getAliasesList()
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Returns:
        A list containing the aliases.

      • getAliasesCount

        int getAliasesCount()
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Returns:
        The count of aliases.

      • getAliases

        java.lang.String getAliases​(int index)
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Parameters:
        index - The index of the element to return.
        Returns:
        The aliases at the given index.

      • getAliasesBytes

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