Package org.mlflow.api.proto

Class ModelRegistry.ModelVersion.Builder

    • Method Detail

      • 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.Builder<ModelRegistry.ModelVersion.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.ModelVersion.Builder>

      • getDefaultInstanceForType

        public ModelRegistry.ModelVersion getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • setRepeatedField

        public ModelRegistry.ModelVersion.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           int index,
                                                           java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.ModelVersion.Builder>

      • addRepeatedField

        public ModelRegistry.ModelVersion.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.ModelVersion.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.ModelVersion.Builder>

      • mergeFrom

        public ModelRegistry.ModelVersion.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ModelRegistry.ModelVersion.Builder>
        Throws:
        java.io.IOException

      • setName

        public ModelRegistry.ModelVersion.Builder setName​(java.lang.String value)
         Unique name of the model
        optional string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • setNameBytes

        public ModelRegistry.ModelVersion.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Unique name of the model
        optional string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • setVersion

        public ModelRegistry.ModelVersion.Builder setVersion​(java.lang.String value)
         Model's version number.
        optional string version = 2;
        Parameters:
        value - The version to set.
        Returns:
        This builder for chaining.

      • setVersionBytes

        public ModelRegistry.ModelVersion.Builder setVersionBytes​(com.google.protobuf.ByteString value)
         Model's version number.
        optional string version = 2;
        Parameters:
        value - The bytes for version to set.
        Returns:
        This builder for chaining.

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

      • setCreationTimestamp

        public ModelRegistry.ModelVersion.Builder setCreationTimestamp​(long value)
         Timestamp recorded when this ``model_version`` was created.
        optional int64 creation_timestamp = 3;
        Parameters:
        value - The creationTimestamp to set.
        Returns:
        This builder for chaining.

      • clearCreationTimestamp

        public ModelRegistry.ModelVersion.Builder clearCreationTimestamp()
         Timestamp recorded when this ``model_version`` was created.
        optional int64 creation_timestamp = 3;
        Returns:
        This builder for chaining.

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

      • setLastUpdatedTimestamp

        public ModelRegistry.ModelVersion.Builder setLastUpdatedTimestamp​(long value)
         Timestamp recorded when metadata for this ``model_version`` was last updated.
        optional int64 last_updated_timestamp = 4;
        Parameters:
        value - The lastUpdatedTimestamp to set.
        Returns:
        This builder for chaining.

      • clearLastUpdatedTimestamp

        public ModelRegistry.ModelVersion.Builder clearLastUpdatedTimestamp()
         Timestamp recorded when metadata for this ``model_version`` was last updated.
        optional int64 last_updated_timestamp = 4;
        Returns:
        This builder for chaining.

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

      • setUserId

        public ModelRegistry.ModelVersion.Builder setUserId​(java.lang.String value)
         User that created this ``model_version``.
        optional string user_id = 5;
        Parameters:
        value - The userId to set.
        Returns:
        This builder for chaining.

      • clearUserId

        public ModelRegistry.ModelVersion.Builder clearUserId()
         User that created this ``model_version``.
        optional string user_id = 5;
        Returns:
        This builder for chaining.

      • setUserIdBytes

        public ModelRegistry.ModelVersion.Builder setUserIdBytes​(com.google.protobuf.ByteString value)
         User that created this ``model_version``.
        optional string user_id = 5;
        Parameters:
        value - The bytes for userId to set.
        Returns:
        This builder for chaining.

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

      • setCurrentStage

        public ModelRegistry.ModelVersion.Builder setCurrentStage​(java.lang.String value)
         Current stage for this ``model_version``.
        optional string current_stage = 6;
        Parameters:
        value - The currentStage to set.
        Returns:
        This builder for chaining.

      • clearCurrentStage

        public ModelRegistry.ModelVersion.Builder clearCurrentStage()
         Current stage for this ``model_version``.
        optional string current_stage = 6;
        Returns:
        This builder for chaining.

      • setCurrentStageBytes

        public ModelRegistry.ModelVersion.Builder setCurrentStageBytes​(com.google.protobuf.ByteString value)
         Current stage for this ``model_version``.
        optional string current_stage = 6;
        Parameters:
        value - The bytes for currentStage to set.
        Returns:
        This builder for chaining.

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

      • setDescription

        public ModelRegistry.ModelVersion.Builder setDescription​(java.lang.String value)
         Description of this ``model_version``.
        optional string description = 7;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public ModelRegistry.ModelVersion.Builder clearDescription()
         Description of this ``model_version``.
        optional string description = 7;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public ModelRegistry.ModelVersion.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         Description of this ``model_version``.
        optional string description = 7;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

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

      • setSource

        public ModelRegistry.ModelVersion.Builder setSource​(java.lang.String value)
         URI indicating the location of the source model artifacts, used when creating ``model_version``
        optional string source = 8;
        Parameters:
        value - The source to set.
        Returns:
        This builder for chaining.

      • clearSource

        public ModelRegistry.ModelVersion.Builder clearSource()
         URI indicating the location of the source model artifacts, used when creating ``model_version``
        optional string source = 8;
        Returns:
        This builder for chaining.

      • setSourceBytes

        public ModelRegistry.ModelVersion.Builder setSourceBytes​(com.google.protobuf.ByteString value)
         URI indicating the location of the source model artifacts, used when creating ``model_version``
        optional string source = 8;
        Parameters:
        value - The bytes for source to set.
        Returns:
        This builder for chaining.

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

      • setRunId

        public ModelRegistry.ModelVersion.Builder setRunId​(java.lang.String value)
         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;
        Parameters:
        value - The runId to set.
        Returns:
        This builder for chaining.

      • clearRunId

        public ModelRegistry.ModelVersion.Builder clearRunId()
         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:
        This builder for chaining.

      • setRunIdBytes

        public ModelRegistry.ModelVersion.Builder setRunIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for runId to set.
        Returns:
        This builder for chaining.

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

      • clearStatus

        public ModelRegistry.ModelVersion.Builder clearStatus()
         Current status of ``model_version``
        optional .mlflow.ModelVersionStatus status = 10;
        Returns:
        This builder for chaining.

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

      • setStatusMessage

        public ModelRegistry.ModelVersion.Builder setStatusMessage​(java.lang.String value)
         Details on current ``status``, if it is pending or failed.
        optional string status_message = 11;
        Parameters:
        value - The statusMessage to set.
        Returns:
        This builder for chaining.

      • clearStatusMessage

        public ModelRegistry.ModelVersion.Builder clearStatusMessage()
         Details on current ``status``, if it is pending or failed.
        optional string status_message = 11;
        Returns:
        This builder for chaining.

      • setStatusMessageBytes

        public ModelRegistry.ModelVersion.Builder setStatusMessageBytes​(com.google.protobuf.ByteString value)
         Details on current ``status``, if it is pending or failed.
        optional string status_message = 11;
        Parameters:
        value - The bytes for statusMessage to set.
        Returns:
        This builder for chaining.

      • clearTags

        public ModelRegistry.ModelVersion.Builder clearTags()
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • removeTags

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

      • getTagsBuilder

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

      • addTagsBuilder

        public ModelRegistry.ModelVersionTag.Builder addTagsBuilder()
         Tags: Additional metadata key-value pairs for this ``model_version``.
        repeated .mlflow.ModelVersionTag tags = 12;

      • addTagsBuilder

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

      • getTagsBuilderList

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

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

      • setRunLink

        public ModelRegistry.ModelVersion.Builder setRunLink​(java.lang.String value)
         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;
        Parameters:
        value - The runLink to set.
        Returns:
        This builder for chaining.

      • clearRunLink

        public ModelRegistry.ModelVersion.Builder clearRunLink()
         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:
        This builder for chaining.

      • setRunLinkBytes

        public ModelRegistry.ModelVersion.Builder setRunLinkBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for runLink to set.
        Returns:
        This builder for chaining.

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

      • setAliases

        public ModelRegistry.ModelVersion.Builder setAliases​(int index,
                                                     java.lang.String value)
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Parameters:
        index - The index to set the value at.
        value - The aliases to set.
        Returns:
        This builder for chaining.

      • addAliases

        public ModelRegistry.ModelVersion.Builder addAliases​(java.lang.String value)
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Parameters:
        value - The aliases to add.
        Returns:
        This builder for chaining.

      • addAllAliases

        public ModelRegistry.ModelVersion.Builder addAllAliases​(java.lang.Iterable<java.lang.String> values)
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Parameters:
        values - The aliases to add.
        Returns:
        This builder for chaining.

      • clearAliases

        public ModelRegistry.ModelVersion.Builder clearAliases()
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Returns:
        This builder for chaining.

      • addAliasesBytes

        public ModelRegistry.ModelVersion.Builder addAliasesBytes​(com.google.protobuf.ByteString value)
         Aliases pointing to this ``model_version``.
        repeated string aliases = 14;
        Parameters:
        value - The bytes of the aliases to add.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ModelRegistry.ModelVersion.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.ModelVersion.Builder>

      • mergeUnknownFields

        public final ModelRegistry.ModelVersion.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.ModelVersion.Builder>