commonMain.aws.sdk.kotlin.services.pinpointemail.model.GetDomainDeliverabilityCampaignRequest.kt Maven / Gradle / Ivy

Go to download

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

The AWS SDK for Kotlin client for Pinpoint Email

There is a newer version: 1.3.77

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

package aws.sdk.kotlin.services.pinpointemail.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (`PutDeliverabilityDashboardOption` operation).
 */
public class GetDomainDeliverabilityCampaignRequest private constructor(builder: Builder) {
    /**
     * The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
     */
    public val campaignId: kotlin.String? = builder.campaignId

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

    override fun toString(): kotlin.String = buildString {
        append("GetDomainDeliverabilityCampaignRequest(")
        append("campaignId=$campaignId")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = campaignId?.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 GetDomainDeliverabilityCampaignRequest

        if (campaignId != other.campaignId) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.
         */
        public var campaignId: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.pinpointemail.model.GetDomainDeliverabilityCampaignRequest) : this() {
            this.campaignId = x.campaignId
        }

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

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