org.apache.gravitino.dto.model

Class ModelVersionDTO

java.lang.Object

org.apache.gravitino.dto.model.ModelVersionDTO

All Implemented Interfaces:

Auditable, ModelVersion

public class ModelVersionDTO
extends java.lang.Object
implements ModelVersion

Represents a model version DTO (Data Transfer Object).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelVersionDTO.Builder Builder for constructing a Model Version DTO.

Constructor Summary

Constructors

Constructor and Description
ModelVersionDTO()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	aliases() The aliases of this model version.
Audit	auditInfo()
static ModelVersionDTO.Builder	builder() Creates a new builder for constructing a Model Version DTO.
java.lang.String	comment() The comment of this model version.
java.util.Map<java.lang.String,java.lang.String>	properties() The properties of the model version.
java.lang.String	uri() The URI of the model artifact.
int	version() The version of this model object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelVersionDTO

public ModelVersionDTO()

Method Detail

auditInfo

public Audit auditInfo()

Specified by:

auditInfo in interface Auditable

Returns:

The audit information of the entity.

version

public int version()

Description copied from interface: ModelVersion

The version of this model object. The version number is an integer number starts from 0. Each time the model checkpoint / snapshot is linked to the registered, the version number will be increased by 1.

Specified by:

version in interface ModelVersion

Returns:

The version of the model object.

comment

public java.lang.String comment()

Description copied from interface: ModelVersion

The comment of this model version. This comment can be different from the comment of the model to provide more detailed information about this version.

Specified by:

comment in interface ModelVersion

Returns:

The comment of the model version. Null is returned if no comment is set.

aliases

public java.lang.String[] aliases()

Description copied from interface: ModelVersion

The aliases of this model version. The aliases are the alternative names of the model version. The aliases are optional. The aliases are unique for a model version. If the alias is already set to one model version, it cannot be set to another model version.

Specified by:

aliases in interface ModelVersion

Returns:

The aliases of the model version.

uri

public java.lang.String uri()

Description copied from interface: ModelVersion

The URI of the model artifact. The URI is the location of the model artifact. The URI can be a file path or a remote URI.

Specified by:

uri in interface ModelVersion

Returns:

The URI of the model artifact.

properties

public java.util.Map<java.lang.String,java.lang.String> properties()

Description copied from interface: ModelVersion

The properties of the model version. The properties are key-value pairs that can be used to store additional information of the model version. The properties are optional.

Specified by:

properties in interface ModelVersion

Returns:

the properties of the model version.

builder

public static ModelVersionDTO.Builder builder()

Creates a new builder for constructing a Model Version DTO.

Returns:

The builder.