File

com.github.cloudfiles.core.Model.File
trait File[ID] extends Element[ID]

A trait representing a file stored on a server.

The trait allows access to metadata properties of the file. The actual content of the file can be downloaded via the FileSystem API.

Type parameters

ID

the type of the ID of a file

Attributes

Graph
Supertypes
trait Element[ID]
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def size: Long

Returns the size of the content of this file.

Returns the size of the content of this file.

Attributes

Returns

the file size

Inherited methods

def createdAt: Instant

Returns the date when this element has been created.

Returns the date when this element has been created.

Attributes

Returns

the creation date of this element

Inherited from:
Element
def description: Option[String]

Returns the description of this element. Not all file systems support such a description, and users typically do not provide one; therefore, this is an ''Option'' and can be ''None''.

Returns the description of this element. Not all file systems support such a description, and users typically do not provide one; therefore, this is an ''Option'' and can be ''None''.

Attributes

Returns

the optional description of this element

Inherited from:
Element
def id: ID

Returns the ID of this element. Via this ID the element can be resolved, e.g. to obtain its metadata or download it (if possible).

Returns the ID of this element. Via this ID the element can be resolved, e.g. to obtain its metadata or download it (if possible).

Attributes

Returns

the ID of this element

Inherited from:
Element
def lastModifiedAt: Instant

Returns the date of the last modification of this element.

Returns the date of the last modification of this element.

Attributes

Returns

the date of last modification

Inherited from:
Element
def name: String

Returns the name of this element. The name is typically displayed to the end user to identify this element.

Returns the name of this element. The name is typically displayed to the end user to identify this element.

Attributes

Returns

the name of this element

Inherited from:
Element