s34k/org.veupathdb.lib.s3.s34k.objects/StreamObject

StreamObject

interface StreamObject : S3Object, AutoCloseable

Handle on an S3 object containing an InputStream over the contents of the remote object.

The wrapped InputStream must be closed when the caller is done with it.

The stream wrapped by this object may be closed by using this type's close method.

Author

Elizabeth Paige Harper https://github.com/Foxcapades

Since

v0.1.0

Functions

abstract fun close()

delete

abstract fun delete()

abstract fun delete(action: DeleteParams.() -> Unit)

abstract fun delete(params: DeleteParams)

Deletes the current object.

exists

abstract fun exists(): Boolean

abstract fun exists(action: ObjectExistsParams.() -> Unit): Boolean

abstract fun exists(params: ObjectExistsParams): Boolean

Tests whether this object still exists.

stat

abstract fun stat(): ObjectMeta?

abstract fun stat(action: ObjectStatParams.() -> Unit): ObjectMeta?

abstract fun stat(params: ObjectStatParams): ObjectMeta?

Fetches metadata for this object.

Properties

baseName

abstract val baseName: String

Returns the base name of this object, or in other words, the last segment of the path.

bucket

abstract val bucket: S3Bucket

dirName

abstract val dirName: String

Returns the 'directory' parent of this object.

eTag

abstract val eTag: String

Object ETag value.

headers

abstract val headers: Headers

lastModified

abstract val lastModified: OffsetDateTime?

Object last modified/created timestamp.

path

abstract val path: String

Path/key to the object this handle represents.

region

abstract val region: String?

stream

abstract val stream: InputStream

Input stream over the contents of the remote object.