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

S3Object

interface S3Object : ObjectResponse

S3 Object

Represents a single object in an S3 store and provides methods and properties for operating on the object and its tags.

Author

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

Since

v0.3.0

Functions

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?

Inheritors

FileObject

StreamObject