org.apache.gravitino.dto.file

Class FilesetDTO

java.lang.Object

org.apache.gravitino.dto.file.FilesetDTO

All Implemented Interfaces:

Auditable, Fileset

public class FilesetDTO
extends java.lang.Object
implements Fileset

Represents a Fileset DTO (Data Transfer Object).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.gravitino.file.Fileset

Fileset.Type

Constructor Summary

Constructors

Constructor and Description
FilesetDTO()

Method Summary

Modifier and Type	Method and Description
AuditDTO	auditInfo()
java.lang.String	comment()
java.lang.String	name()
java.util.Map<java.lang.String,java.lang.String>	properties()
java.lang.String	storageLocation() Get the storage location of the file or directory path that is managed by this fileset object.
Fileset.Type	type()

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.file.Fileset

supportsRoles, supportsTags

Constructor Detail

FilesetDTO

public FilesetDTO()

Method Detail

name

public java.lang.String name()

Specified by:

name in interface Fileset

Returns:

Name of the fileset object.

comment

@Nullable
public java.lang.String comment()

Specified by:

comment in interface Fileset

Returns:

The comment of the fileset object. Null is returned if no comment is set.

type

public Fileset.Type type()

Specified by:

type in interface Fileset

Returns:

The type of the fileset object.

storageLocation

public java.lang.String storageLocation()

Description copied from interface: Fileset

Get the storage location of the file or directory path that is managed by this fileset object.

The returned storageLocation can either be the one specified when creating the fileset object, or the one specified in the catalog / schema level if the fileset object is created under this catalog / schema.

For managed fileset, the storageLocation can be:

1) The one specified when creating the fileset object.

2) When catalog property "location" is specified but schema property "location" is not specified, then the storageLocation will be "{catalog location}/schemaName/filesetName".

3) When catalog property "location" is not specified but schema property "location" is specified, then the storageLocation will be "{schema location}/filesetName".

4) When both catalog property "location" and schema property "location" are specified, then the storageLocation will be "{schema location}/filesetName".

5) When both catalog property "location" and schema property "location" are not specified, and storageLocation specified when creating the fileset object is null, this situation is illegal.

For external fileset, the storageLocation can be:

1) The one specified when creating the fileset object.

Specified by:

storageLocation in interface Fileset

Returns:

The storage location of the fileset object.

properties

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

Specified by:

properties in interface Fileset

Returns:

The properties of the fileset object. Empty map is returned if no properties are set.

auditInfo

public AuditDTO auditInfo()

Specified by:

auditInfo in interface Auditable

Returns:

The audit information of the entity.