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 java.lang.Object
implements Model

Represents a model DTO (Data Transfer Object).

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModelDTO()

Method Summary

Modifier and Type	Method and Description
AuditDTO	auditInfo()
static ModelDTO.Builder	builder() Creates a new builder for constructing a Model DTO.
java.lang.String	comment() The comment of the model object.
int	latestVersion() The latest version of the model object.
java.lang.String	name()
java.util.Map<java.lang.String,java.lang.String>	properties() The properties of the model object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.gravitino.model.Model

supportsRoles, supportsTags

Constructor Detail

ModelDTO

public ModelDTO()

Method Detail

name

public java.lang.String name()

Specified by:

name in interface Model

Returns:

Name of the model object.

comment

public java.lang.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 java.util.Map<java.lang.String,java.lang.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.