Skip to content

Commit 9a3f688

Browse files
Copilotafranken
andcommitted
docs: add KDoc to new bucket tagging methods in BucketService and BucketStore
Co-authored-by: afranken <763000+afranken@users.noreply.github.com>
1 parent 80432af commit 9a3f688

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

server/src/main/kotlin/com/adobe/testing/s3mock/service/BucketService.kt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,17 +184,26 @@ open class BucketService(
184184
return bucketMetadata.bucketLifecycleConfiguration ?: throw S3Exception.NO_SUCH_LIFECYCLE_CONFIGURATION
185185
}
186186

187+
/**
188+
* [API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html).
189+
*/
187190
fun getBucketTagging(bucketName: String): Tagging {
188191
val bucketMetadata = bucketStore.getBucketMetadata(bucketName)
189192
val tags = bucketMetadata.tagging ?: emptyList()
190193
return Tagging(TagSet(tags))
191194
}
192195

196+
/**
197+
* [API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html).
198+
*/
193199
fun setBucketTagging(bucketName: String, tagging: Tagging) {
194200
val bucketMetadata = bucketStore.getBucketMetadata(bucketName)
195201
bucketStore.storeBucketTagging(bucketMetadata, tagging.tagSet.tags)
196202
}
197203

204+
/**
205+
* [API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html).
206+
*/
198207
fun deleteBucketTagging(bucketName: String) {
199208
val bucketMetadata = bucketStore.getBucketMetadata(bucketName)
200209
bucketStore.storeBucketTagging(bucketMetadata, null)

server/src/main/kotlin/com/adobe/testing/s3mock/store/BucketStore.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,9 @@ open class BucketStore(
196196
}
197197
}
198198

199+
/**
200+
* [API Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html).
201+
*/
199202
fun storeBucketTagging(
200203
metadata: BucketMetadata,
201204
tagging: List<Tag>?

0 commit comments

Comments
 (0)