S3FileDescriptor

Instance Constructors

new S3FileDescriptor(bucket: S3Bucket, elements: List[String], summary: Option[S3ObjectSummary] = None)

Type Members

type Self = S3FileDescriptor

Definition Classes
S3FileDescriptor → RemoteFileDescriptor

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def /(name: String): FileDescriptor

Adds a new child node to the filesystem path.
Adds a new child node to the filesystem path.
name
the node name.
returns
the new file descriptor with the updated path

Definition Classes
FileDescriptor
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bucket: S3Bucket
val bucketName: String
def cd(pathString: String): S3FileDescriptor

Changes the path of the file descriptor using unix's cd syntax related to the current directory.
Changes the path of the file descriptor using unix's cd syntax related to the current directory. Ex: Go back to directories: ../.. Go to child directories: foo/bar Go to sibling directory: ../foo Absolute path changes are not supported.
pathString
the cd command
returns
the new file descriptor with the updated path

Definition Classes
S3FileDescriptor → FileDescriptor
def child(name: String): Self

Definition Classes
RemoteFileDescriptor
def children(names: String*): Self

Definition Classes
RemoteFileDescriptor
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delete(): Boolean

Deletes the file associated with the file descriptor
Deletes the file associated with the file descriptor
returns
true if the delete was successful, false otherwise.

Definition Classes
S3FileDescriptor → FileDescriptor
def download(localTarget: LocalFileDescriptor, safeDownloading: Boolean): Boolean

Downloads the file to the given local destination.
Downloads the file to the given local destination. Both the source and the destination must point to a file.
localTarget
the local destination to which this file should be downloaded. The path must be absolute path to the final file.
safeDownloading
downloads the file to filename + ".tmp" and renames it to the original name if the download was successful.
returns
true if the download was successful, false otherwise.

Definition Classes
S3FileDescriptor → FileDescriptor
def duplicate(elements: List[String]): S3FileDescriptor

Attributes
protected
Definition Classes
S3FileDescriptor → RemoteFileDescriptor
val elements: List[String]

Attributes
protected
Definition Classes
S3FileDescriptor → RemoteFileDescriptor
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def exists: Boolean

Returns true if the file pointed by the file descriptor exists
Returns true if the file pointed by the file descriptor exists
returns
true if the file pointed by the file descriptor exists

Definition Classes
S3FileDescriptor → FileDescriptor
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def isDirectory: Boolean

Returns true if the fd points to a directory
Returns true if the fd points to a directory
returns
true if the fd points to a directory

Definition Classes
S3FileDescriptor → FileDescriptor
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lines(): Iterator[String]

Returns an iterator with the lines of this file.
Returns an iterator with the lines of this file.
returns
an iterator with the lines of this file.

Definition Classes
FileDescriptor
def list: Iterator[S3FileDescriptor]

Lists the files in the current file descriptor directory
Lists the files in the current file descriptor directory
returns
a iterator of file descriptors

Definition Classes
S3FileDescriptor → FileDescriptor
def listAllFilesWithPrefix(prefix: String): Iterator[S3FileDescriptor]

Lists all files down the file hierarchy tree that whose relative path match the given prefix
Lists all files down the file hierarchy tree that whose relative path match the given prefix
prefix
the prefix to match given each file relative path to the current directory
returns
a iterator of file descriptors

Definition Classes
S3FileDescriptor → FileDescriptor
lazy val log: Logger

The Logger object.
The Logger object. This logger will have the same name as the concrete class into which this trait is mixed-in.

Definition Classes
Logging
def mkdirs(): Boolean

Creates intermediary directories
Creates intermediary directories
returns
true if the creation of successful, false otherwise.

Definition Classes
S3FileDescriptor → FileDescriptor
lazy val name: String

Definition Classes
RemoteFileDescriptor
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parent(n: Int = 1): Self

Definition Classes
RemoteFileDescriptor
lazy val path: String

Definition Classes
RemoteFileDescriptor
val root: String

Attributes
protected
Definition Classes
S3FileDescriptor → RemoteFileDescriptor
def sibling(f: (String) ⇒ String): S3FileDescriptor

Returns a new file descriptor pointing to a sibling of the current file descriptor
Returns a new file descriptor pointing to a sibling of the current file descriptor
f
a function that returns a new name from the current name of the file descriptor
returns
a new file descriptor pointing to a sibling of the current file descriptor

Definition Classes
S3FileDescriptor → FileDescriptor
def sibling(name: String): FileDescriptor

Returns a new file descriptor pointing to a sibling of the current file descriptor
Returns a new file descriptor pointing to a sibling of the current file descriptor
name
the file name of the new file descriptor
returns
a new file descriptor pointing to a sibling of the current file descriptor

Definition Classes
FileDescriptor
def size: Long

The size of the file associated with the file descriptor.
The size of the file associated with the file descriptor.

Definition Classes
S3FileDescriptor → FileDescriptor
def stream(offset: Long = 0L): InputStream

Returns an input stream for the contents of this file.
Returns an input stream for the contents of this file.
offset
bytes to skip before reading the file.
returns
an input stream for the contents of this file.

Definition Classes
S3FileDescriptor → FileDescriptor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
S3FileDescriptor → AnyRef → Any
def upload(inputStream: InputStream, length: Option[Long]): Boolean

Uploads an input stream to this file's location.
Uploads an input stream to this file's location. The target must point to a file.
inputStream
the input stream that should be uploaded.
length
the input stream length (leaving this as None can have performance implications)
returns
true if the upload was successful, false otherwise.

Definition Classes
S3FileDescriptor → FileDescriptor
def upload(localTarget: LocalFileDescriptor): Boolean

Uploads a local file to this file's location.
Uploads a local file to this file's location. Both the source and the target must point to a file.
localTarget
the local file that should be uploaded. The path must be absolute path to the final file.
returns
true if the upload was successful, false otherwise.

Definition Classes
S3FileDescriptor → FileDescriptor
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object S3FileDescriptor | package io

case class S3FileDescriptor(bucket: S3Bucket, elements: List[String], summary: Option[S3ObjectSummary] = None) extends FileDescriptor with RemoteFileDescriptor with Logging with Product with Serializable

Instance Constructors

new S3FileDescriptor(bucket: S3Bucket, elements: List[String], summary: Option[S3ObjectSummary] = None)

Type Members

type Self = S3FileDescriptor

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def /(name: String): FileDescriptor

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val bucket: S3Bucket

val bucketName: String

def cd(pathString: String): S3FileDescriptor

def child(name: String): Self

def children(names: String*): Self

def clone(): AnyRef

def delete(): Boolean

def download(localTarget: LocalFileDescriptor, safeDownloading: Boolean): Boolean

def duplicate(elements: List[String]): S3FileDescriptor

val elements: List[String]

final def eq(arg0: AnyRef): Boolean

def exists: Boolean

def finalize(): Unit

final def getClass(): Class[_]

def isDirectory: Boolean

final def isInstanceOf[T0]: Boolean

def lines(): Iterator[String]

def list: Iterator[S3FileDescriptor]

def listAllFilesWithPrefix(prefix: String): Iterator[S3FileDescriptor]

lazy val log: Logger

def mkdirs(): Boolean

lazy val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parent(n: Int = 1): Self

lazy val path: String

val root: String

def sibling(f: (String) ⇒ String): S3FileDescriptor

def sibling(name: String): FileDescriptor

def size: Long

def stream(offset: Long = 0L): InputStream

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def upload(inputStream: InputStream, length: Option[Long]): Boolean

def upload(localTarget: LocalFileDescriptor): Boolean

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Logging

Inherited from RemoteFileDescriptor

Inherited from FileDescriptor

Inherited from AnyRef

Inherited from Any

Ungrouped