Package org.mlflow.api.proto

Interface ModelRegistry.TransitionModelVersionStageOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getArchiveExistingVersions()
    When transitioning a model version to a particular stage, this flag dictates whether all existing model versions in that stage should be atomically moved to the "archived" stage.
    String
    getName()
    Name of the registered model
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the registered model
    String
    getStage()
    Transition `model_version` to new stage.
    com.google.protobuf.ByteString
    getStageBytes()
    Transition `model_version` to new stage.
    String
    getVersion()
    Model version number
    com.google.protobuf.ByteString
    getVersionBytes()
    Model version number
    boolean
    hasArchiveExistingVersions()
    When transitioning a model version to a particular stage, this flag dictates whether all existing model versions in that stage should be atomically moved to the "archived" stage.
    boolean
    hasName()
    Name of the registered model
    boolean
    hasStage()
    Transition `model_version` to new stage.
    boolean
    hasVersion()
    Model 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 Details

    • hasName

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

    • getName

      String getName()
       Name of the registered model
      optional string name = 1 [(.mlflow.validate_required) = true];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the registered model
      optional string name = 1 [(.mlflow.validate_required) = true];
      Returns:
      The bytes for name.

    • hasVersion

      boolean hasVersion()
       Model version number
      optional string version = 2 [(.mlflow.validate_required) = true];
      Returns:
      Whether the version field is set.

    • getVersion

      String getVersion()
       Model version number
      optional string version = 2 [(.mlflow.validate_required) = true];
      Returns:
      The version.

    • getVersionBytes

      com.google.protobuf.ByteString getVersionBytes()
       Model version number
      optional string version = 2 [(.mlflow.validate_required) = true];
      Returns:
      The bytes for version.

    • hasStage

      boolean hasStage()
       Transition `model_version` to new stage.
      optional string stage = 3 [(.mlflow.validate_required) = true];
      Returns:
      Whether the stage field is set.

    • getStage

      String getStage()
       Transition `model_version` to new stage.
      optional string stage = 3 [(.mlflow.validate_required) = true];
      Returns:
      The stage.

    • getStageBytes

      com.google.protobuf.ByteString getStageBytes()
       Transition `model_version` to new stage.
      optional string stage = 3 [(.mlflow.validate_required) = true];
      Returns:
      The bytes for stage.

    • hasArchiveExistingVersions

      boolean hasArchiveExistingVersions()
       When transitioning a model version to a particular stage, this flag dictates whether all
 existing model versions in that stage should be atomically moved to the "archived" stage.
 This ensures that at-most-one model version exists in the target stage.
 This field is *required* when transitioning a model versions's stage
      optional bool archive_existing_versions = 4 [(.mlflow.validate_required) = true];
      Returns:
      Whether the archiveExistingVersions field is set.

    • getArchiveExistingVersions

      boolean getArchiveExistingVersions()
       When transitioning a model version to a particular stage, this flag dictates whether all
 existing model versions in that stage should be atomically moved to the "archived" stage.
 This ensures that at-most-one model version exists in the target stage.
 This field is *required* when transitioning a model versions's stage
      optional bool archive_existing_versions = 4 [(.mlflow.validate_required) = true];
      Returns:
      The archiveExistingVersions.