commonMain.aws.sdk.kotlin.services.cleanrooms.model.PrivacyBudget.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cleanrooms-jvm Show documentation

The AWS SDK for Kotlin client for CleanRooms

There is a newer version: 1.3.35

// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.cleanrooms.model



/**
 * The epsilon parameter value and number of each aggregation function that you can perform.
 */
public sealed class PrivacyBudget {
    /**
     * An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
     */
    public data class DifferentialPrivacy(val value: aws.sdk.kotlin.services.cleanrooms.model.DifferentialPrivacyPrivacyBudget) : aws.sdk.kotlin.services.cleanrooms.model.PrivacyBudget() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.cleanrooms.model.PrivacyBudget() {
    }

    /**
     * Casts this [PrivacyBudget] as a [DifferentialPrivacy] and retrieves its [aws.sdk.kotlin.services.cleanrooms.model.DifferentialPrivacyPrivacyBudget] value. Throws an exception if the [PrivacyBudget] is not a
     * [DifferentialPrivacy].
     */
    public fun asDifferentialPrivacy(): aws.sdk.kotlin.services.cleanrooms.model.DifferentialPrivacyPrivacyBudget = (this as PrivacyBudget.DifferentialPrivacy).value

    /**
     * Casts this [PrivacyBudget] as a [DifferentialPrivacy] and retrieves its [aws.sdk.kotlin.services.cleanrooms.model.DifferentialPrivacyPrivacyBudget] value. Returns null if the [PrivacyBudget] is not a [DifferentialPrivacy].
     */
    public fun asDifferentialPrivacyOrNull(): aws.sdk.kotlin.services.cleanrooms.model.DifferentialPrivacyPrivacyBudget? = (this as? PrivacyBudget.DifferentialPrivacy)?.value
}