ObjectTouchParams

Touch object operation parameters.

Object touch creates an empty object in the target bucket if no such object already exists. This behavior may be changed using the overwrite flag.

This is a 'complex operation' in that it may happen in 2 independently configurable phases:

  1. Lookup an existing object at the target path.

  2. Put a blank object at the target path.

If overwrite is set to true, phase one is skipped and an object is put into the target bucket no matter what.

If overwrite is set to false, phase two is skipped if an object already exists in the store at the target path.

Author

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

Since

v0.1.0

Properties

Link copied to clipboard
abstract var callback: (handle: S3Object) -> Unit?

Optional callback that will be executed on successful completion of this S3 operation.

Link copied to clipboard
abstract var contentType: String?

Content type for the object if it is created.

Link copied to clipboard
abstract val getParams: OTGetParams

Parameters specific to the get phase of the object touch operation.

Link copied to clipboard
abstract override val headers: MutableHeaders

Global headers that will be applied to all phases of the operation.

Link copied to clipboard
abstract var overwrite: Boolean

Whether a pre-existing object already in the store should be overwritten with a blank file created by this operation.

Link copied to clipboard
abstract val putParams: OTPutParams

Parameters specific to the put phase of the object touch operation.

Link copied to clipboard
abstract override val queryParams: MutableQueryParams

Global query params that will be applied to all phases of the operation.

Link copied to clipboard
abstract var region: String?