Package org.mlflow.api.proto

Class ModelRegistry.ModelVersion

    • Method Detail

      • newInstance

        protected java.lang.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

      • 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.

      • 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.

      • 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.

      • 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 java.lang.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 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;
        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.

      • 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 java.lang.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.

      • 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 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;
        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.

      • getAliases

        public java.lang.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 java.lang.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.

      • 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.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.ModelVersion parseFrom​(java.nio.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​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static ModelRegistry.ModelVersion parseFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.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

      • 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

      • 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