s34k/org.veupathdb.lib.s3.s34k.buckets/BucketTagContainer/get

get

abstract operator fun get(key: String): String?

Gets the target tag from this S3Bucket.

Return

The value of the target key, if such a key exists, otherwise null.

Parameters

key

Key of the tag to fetch.

Throws

If the given key violates the rules outlined in the Tag documentation.

If this S3Bucket 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 get(vararg keys: String): TagMap
abstract fun get(keys: Iterable<String>): TagMap

Gets the target tags from this S3Bucket.

Return

A tag map containing only the specified tags that exist on the target S3Bucket.

Parameters

keys

Keys of the tags to fetch.

Throws

If any of the given keys violate the rules outlined in the Tag documentation.

If this S3Bucket 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 get(action: TagGetParams.() -> Unit): TagMap

Gets the target tags from this S3Bucket.

Return

A tag map containing only the specified tags that exist on the target S3Bucket.

Parameters

action

Action used to configure this operation.

Throws

If this S3Bucket 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 get(params: TagGetParams): TagMap

Gets the target tags from this S3Bucket.

Return

A tag map containing only the specified tags that exist on the target S3Bucket.

Parameters

params

Parameters used to configure this operation.

Throws

If this S3Bucket does not exist.

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