commonMain.aws.sdk.kotlin.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinpointsmsvoicev2-jvm Show documentation
The AWS SDK for Kotlin client for Pinpoint SMS Voice V2
There is a newer version: 1.3.78
Show newest version
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.pinpointsmsvoicev2.model

import aws.smithy.kotlin.runtime.SdkDsl

public class DescribeOptedOutNumbersRequest private constructor(builder: Builder) {
    /**
     * An array of OptedOutFilter objects to filter the results on.
     */
    public val filters: List? = builder.filters
    /**
     * The maximum number of results to return per each request.
     */
    public val maxResults: kotlin.Int? = builder.maxResults
    /**
     * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
     *
     * If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
     */
    public val optOutListName: kotlin.String? = builder.optOutListName
    /**
     * An array of phone numbers to search for in the OptOutList.
     *
     * If you specify an opted out number that isn't valid, an exception is returned.
     */
    public val optedOutNumbers: List? = builder.optedOutNumbers

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("DescribeOptedOutNumbersRequest(")
        append("filters=$filters,")
        append("maxResults=$maxResults,")
        append("nextToken=$nextToken,")
        append("optOutListName=$optOutListName,")
        append("optedOutNumbers=$optedOutNumbers")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = filters?.hashCode() ?: 0
        result = 31 * result + (maxResults ?: 0)
        result = 31 * result + (nextToken?.hashCode() ?: 0)
        result = 31 * result + (optOutListName?.hashCode() ?: 0)
        result = 31 * result + (optedOutNumbers?.hashCode() ?: 0)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as DescribeOptedOutNumbersRequest

        if (filters != other.filters) return false
        if (maxResults != other.maxResults) return false
        if (nextToken != other.nextToken) return false
        if (optOutListName != other.optOutListName) return false
        if (optedOutNumbers != other.optedOutNumbers) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * An array of OptedOutFilter objects to filter the results on.
         */
        public var filters: List? = null
        /**
         * The maximum number of results to return per each request.
         */
        public var maxResults: kotlin.Int? = null
        /**
         * The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
         */
        public var nextToken: kotlin.String? = null
        /**
         * The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
         *
         * If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
         */
        public var optOutListName: kotlin.String? = null
        /**
         * An array of phone numbers to search for in the OptOutList.
         *
         * If you specify an opted out number that isn't valid, an exception is returned.
         */
        public var optedOutNumbers: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest) : this() {
            this.filters = x.filters
            this.maxResults = x.maxResults
            this.nextToken = x.nextToken
            this.optOutListName = x.optOutListName
            this.optedOutNumbers = x.optedOutNumbers
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.pinpointsmsvoicev2.model.DescribeOptedOutNumbersRequest = DescribeOptedOutNumbersRequest(this)

        internal fun correctErrors(): Builder {
            return this
        }
    }
}