open

abstract fun open(path: String): StreamObject?

Fetches the object at the target path and returns a handle on it which can be used to stream out the target object's contents.

If the target path does not exist, or is a directory, null will be returned.

Return

An StreamObject instance handle on the target object, or null if no such object could be found.

Parameters

path

Path to the target object.

Throws

If this bucket or the bucket in which this object container resides no longer exists.

If an implementation specific exception is thrown. The implementation specific exception will be set to the thrown exception's 'cause' value.


abstract fun open(path: String, action: ObjectOpenParams.() -> Unit): StreamObject?

Fetches the configured target object and returns a handle on it which can be used to stream out the target object's contents.

If the target path does not exist, or is a directory, null will be returned.

Return

An StreamObject instance handle on the target object, or null if no such object could be found.

Parameters

action

Action used to configure the backing S3 operation.

Throws

If this bucket or the bucket in which this object container resides no longer exists.

If an implementation specific exception is thrown. The implementation specific exception will be set to the thrown exception's 'cause' value.


abstract fun open(path: String, params: ObjectOpenParams): StreamObject?

Fetches the configured target object and returns a handle on it which can be used to stream out the target object's contents.

If the target path does not exist, or is a directory, null will be returned.

Return

An StreamObject instance handle on the target object, or null if no such object could be found.

Parameters

params

Parameters for the backing S3 operation.

Throws

If this bucket or the bucket in which this object container resides no longer exists.

If an implementation specific exception is thrown. The implementation specific exception will be set to the thrown exception's 'cause' value.