Package org.mlflow.api.proto

Interface ModelRegistry.CreateModelVersionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ModelRegistry.CreateModelVersion, ModelRegistry.CreateModelVersion.Builder
Enclosing class:
ModelRegistry
public static interface ModelRegistry.CreateModelVersionOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Optional description for model version.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional description for model version.
    String
    getModelId()
    Optional `model_id` for model version that is used to link the registered model to the source logged model
    com.google.protobuf.ByteString
    getModelIdBytes()
    Optional `model_id` for model version that is used to link the registered model to the source logged model
    ModelRegistry.ModelParam
    getModelParams(int index)
    Optional parameters for the model.
    int
    getModelParamsCount()
    Optional parameters for the model.
    List<ModelRegistry.ModelParam>
    getModelParamsList()
    Optional parameters for the model.
    ModelRegistry.ModelParamOrBuilder
    getModelParamsOrBuilder(int index)
    Optional parameters for the model.
    List<? extends ModelRegistry.ModelParamOrBuilder>
    getModelParamsOrBuilderList()
    Optional parameters for the model.
    String
    getName()
    Register model under this name
    com.google.protobuf.ByteString
    getNameBytes()
    Register model under this name
    String
    getRunId()
    MLflow run ID for correlation, if ``source`` was generated by an experiment run in MLflow tracking server
    com.google.protobuf.ByteString
    getRunIdBytes()
    MLflow run ID for correlation, if ``source`` was generated by an experiment run in MLflow tracking server
    String
    getRunLink()
    MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.
    com.google.protobuf.ByteString
    getRunLinkBytes()
    MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.
    String
    getSource()
    URI indicating the location of the model artifacts.
    com.google.protobuf.ByteString
    getSourceBytes()
    URI indicating the location of the model artifacts.
    ModelRegistry.ModelVersionTag
    getTags(int index)
    Additional metadata for model version.
    int
    getTagsCount()
    Additional metadata for model version.
    List<ModelRegistry.ModelVersionTag>
    getTagsList()
    Additional metadata for model version.
    ModelRegistry.ModelVersionTagOrBuilder
    getTagsOrBuilder(int index)
    Additional metadata for model version.
    List<? extends ModelRegistry.ModelVersionTagOrBuilder>
    getTagsOrBuilderList()
    Additional metadata for model version.
    boolean
    hasDescription()
    Optional description for model version.
    boolean
    hasModelId()
    Optional `model_id` for model version that is used to link the registered model to the source logged model
    boolean
    hasName()
    Register model under this name
    boolean
    hasRunId()
    MLflow run ID for correlation, if ``source`` was generated by an experiment run in MLflow tracking server
    boolean
    hasRunLink()
    MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.
    boolean
    hasSource()
    URI indicating the location of the model artifacts.

    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 Details

    • hasName

      boolean hasName()
       Register model under this name
      optional string name = 1 [(.mlflow.validate_required) = true];
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Register model under this name
      optional string name = 1 [(.mlflow.validate_required) = true];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Register model under this name
      optional string name = 1 [(.mlflow.validate_required) = true];
      Returns:
      The bytes for name.

    • hasSource

      boolean hasSource()
       URI indicating the location of the model artifacts.
      optional string source = 2 [(.mlflow.validate_required) = true];
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
       URI indicating the location of the model artifacts.
      optional string source = 2 [(.mlflow.validate_required) = true];
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       URI indicating the location of the model artifacts.
      optional string source = 2 [(.mlflow.validate_required) = true];
      Returns:
      The bytes for source.

    • hasRunId

      boolean hasRunId()
       MLflow run ID for correlation, if ``source`` was generated by an experiment run in
 MLflow tracking server
      optional string run_id = 3;
      Returns:
      Whether the runId field is set.

    • getRunId

      String getRunId()
       MLflow run ID for correlation, if ``source`` was generated by an experiment run in
 MLflow tracking server
      optional string run_id = 3;
      Returns:
      The runId.

    • getRunIdBytes

      com.google.protobuf.ByteString getRunIdBytes()
       MLflow run ID for correlation, if ``source`` was generated by an experiment run in
 MLflow tracking server
      optional string run_id = 3;
      Returns:
      The bytes for runId.

    • getTagsList

      List<ModelRegistry.ModelVersionTag> getTagsList()
       Additional metadata for model version.
      repeated .mlflow.ModelVersionTag tags = 4;

    • getTags

      ModelRegistry.ModelVersionTag getTags(int index)
       Additional metadata for model version.
      repeated .mlflow.ModelVersionTag tags = 4;

    • getTagsCount

      int getTagsCount()
       Additional metadata for model version.
      repeated .mlflow.ModelVersionTag tags = 4;

    • getTagsOrBuilderList

      List<? extends ModelRegistry.ModelVersionTagOrBuilder> getTagsOrBuilderList()
       Additional metadata for model version.
      repeated .mlflow.ModelVersionTag tags = 4;

    • getTagsOrBuilder

      ModelRegistry.ModelVersionTagOrBuilder getTagsOrBuilder(int index)
       Additional metadata for model version.
      repeated .mlflow.ModelVersionTag tags = 4;

    • hasRunLink

      boolean hasRunLink()
       MLflow run link - this is the exact link of the run that generated this model version,
 potentially hosted at another instance of MLflow.
      optional string run_link = 5;
      Returns:
      Whether the runLink field is set.

    • getRunLink

      String getRunLink()
       MLflow run link - this is the exact link of the run that generated this model version,
 potentially hosted at another instance of MLflow.
      optional string run_link = 5;
      Returns:
      The runLink.

    • getRunLinkBytes

      com.google.protobuf.ByteString getRunLinkBytes()
       MLflow run link - this is the exact link of the run that generated this model version,
 potentially hosted at another instance of MLflow.
      optional string run_link = 5;
      Returns:
      The bytes for runLink.

    • hasDescription

      boolean hasDescription()
       Optional description for model version.
      optional string description = 6;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       Optional description for model version.
      optional string description = 6;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional description for model version.
      optional string description = 6;
      Returns:
      The bytes for description.

    • hasModelId

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

    • getModelId

      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 = 7;
      Returns:
      The modelId.

    • getModelIdBytes

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

    • getModelParamsList

      List<ModelRegistry.ModelParam> getModelParamsList()
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 8;

    • getModelParams

      ModelRegistry.ModelParam getModelParams(int index)
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 8;

    • getModelParamsCount

      int getModelParamsCount()
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 8;

    • getModelParamsOrBuilderList

      List<? extends ModelRegistry.ModelParamOrBuilder> getModelParamsOrBuilderList()
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 8;

    • getModelParamsOrBuilder

      ModelRegistry.ModelParamOrBuilder getModelParamsOrBuilder(int index)
       Optional parameters for the model.
      repeated .mlflow.ModelParam model_params = 8;