Package org.apache.gravitino.dto.model

Class ModelDTO

java.lang.Object
org.apache.gravitino.dto.model.ModelDTO
All Implemented Interfaces:
Auditable, Model
public class ModelDTO extends Object implements Model
Represents a model DTO (Data Transfer Object).

  • Constructor Details

    • ModelDTO

      public ModelDTO()

  • Method Details

    • name

      public String name()
      Specified by:
      name in interface Model
      Returns:
      Name of the model object.

    • comment

      public String comment()
      Description copied from interface: Model
      The comment of the model object. This is the general description of the model object. User can still add more detailed information in the model version.
      Specified by:
      comment in interface Model
      Returns:
      The comment of the model object. Null is returned if no comment is set.

    • properties

      public Map<String,String> properties()
      Description copied from interface: Model
      The properties of the model object. The properties are key-value pairs that can be used to store additional information of the model object. The properties are optional.

      Users can still specify the properties in the model version for different information.

      Specified by:
      properties in interface Model
      Returns:
      the properties of the model object.

    • latestVersion

      public int latestVersion()
      Description copied from interface: Model
      The latest version of the model object. The latest version is the version number of the latest model checkpoint / snapshot that is linked to the registered model.
      Specified by:
      latestVersion in interface Model
      Returns:
      The latest version of the model object.

    • auditInfo

      public AuditDTO auditInfo()
      Specified by:
      auditInfo in interface Auditable
      Returns:
      The audit information of the entity.

    • builder

      public static ModelDTO.Builder builder()
      Creates a new builder for constructing a Model DTO.
      Returns:
      The builder.