put

abstract fun put(key: String, value: String)

Puts the given key/value pair as a tag on this tag container.

See also

Parameters

key

Key of the tag to put.

value

Value of the tag to put.

Throws

If either the key or value violate the rules outlined in the Tag documentation.

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(vararg tags: Tag)

Puts the given tags onto this tag container.

Parameters

tags

Tags to set on this tag container. If this value is empty, this method does nothing.

Throws

If the given tag array contains more than 10 values.

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(vararg tags: Pair<String, String>)

Puts the given tags onto this tag container.

Parameters

tags

Tags to set on this tag container. If this value is empty, this method does nothing.

Throws

If the given tag array contains more than 10 values, or if any of the keys or values violate the rules outlined in the Tag documentation

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(tags: Iterable<Tag>)

Puts the given tags onto this tag container.

Parameters

tags

Tags to set on this tag container. If this iterable contains no elements, this method does nothing.

Throws

If the given tag iterable contains more than 10 elements.

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(tags: Map<String, String>)

Puts the given tags onto this tag container.

Parameters

tags

Tags to set on this tag container. If this map is empty, this method does nothing.

Throws

If the given tag map contains more than 10 entries, or if any of the keys or values violate the rules outlined in the Tag documentation

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(tags: TagMap)

Puts the given tags onto this tag container.

Parameters

tags

Map of S3 tags to put on this tag container. If this tag map is empty, this method does nothing.

Throws

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(action: TagPutParams.() -> Unit)

Puts the configured tags onto this tag container.

If the configured tag map is empty, this method does nothing.

Parameters

action

Action used to configure the backing S3 operation.

Throws

If this Object does not exist.

If the parent bucket of this Object does not exist.

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


abstract fun put(params: TagPutParams)

Puts the configured tags onto this tag container.

If the configured tag map is empty, this method does nothing.

Parameters

params

Parameters for the backing S3 operation.

Throws

If this Object does not exist.

If the parent bucket of this Object does not exist.

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