commonMain.aws.sdk.kotlin.services.fsx.model.DescribeSnapshotsRequest.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fsx-jvm Show documentation
The AWS SDK for Kotlin client for FSx
There is a newer version: 1.3.34
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.fsx.model

import aws.smithy.kotlin.runtime.SdkDsl

public class DescribeSnapshotsRequest private constructor(builder: Builder) {
    /**
     * The filters structure. The supported names are `file-system-id` or `volume-id`.
     */
    public val filters: List? = builder.filters
    /**
     * Set to `false` (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to `true` if you want to see the snapshots in your account and the ones shared with you from another account.
     */
    public val includeShared: kotlin.Boolean? = builder.includeShared
    /**
     * The maximum number of resources to return in the response. This value must be an integer greater than zero.
     */
    public val maxResults: kotlin.Int? = builder.maxResults
    /**
     * (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off.
     */
    public val nextToken: kotlin.String? = builder.nextToken
    /**
     * The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a `SnapshotNotFound` error occurs.
     */
    public val snapshotIds: List? = builder.snapshotIds

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

    override fun toString(): kotlin.String = buildString {
        append("DescribeSnapshotsRequest(")
        append("filters=$filters,")
        append("includeShared=$includeShared,")
        append("maxResults=$maxResults,")
        append("nextToken=$nextToken,")
        append("snapshotIds=$snapshotIds")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = filters?.hashCode() ?: 0
        result = 31 * result + (includeShared?.hashCode() ?: 0)
        result = 31 * result + (maxResults ?: 0)
        result = 31 * result + (nextToken?.hashCode() ?: 0)
        result = 31 * result + (snapshotIds?.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 DescribeSnapshotsRequest

        if (filters != other.filters) return false
        if (includeShared != other.includeShared) return false
        if (maxResults != other.maxResults) return false
        if (nextToken != other.nextToken) return false
        if (snapshotIds != other.snapshotIds) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The filters structure. The supported names are `file-system-id` or `volume-id`.
         */
        public var filters: List? = null
        /**
         * Set to `false` (default) if you want to only see the snapshots owned by your Amazon Web Services account. Set to `true` if you want to see the snapshots in your account and the ones shared with you from another account.
         */
        public var includeShared: kotlin.Boolean? = null
        /**
         * The maximum number of resources to return in the response. This value must be an integer greater than zero.
         */
        public var maxResults: kotlin.Int? = null
        /**
         * (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous `NextToken` value left off.
         */
        public var nextToken: kotlin.String? = null
        /**
         * The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a `SnapshotNotFound` error occurs.
         */
        public var snapshotIds: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.fsx.model.DescribeSnapshotsRequest) : this() {
            this.filters = x.filters
            this.includeShared = x.includeShared
            this.maxResults = x.maxResults
            this.nextToken = x.nextToken
            this.snapshotIds = x.snapshotIds
        }

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

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