commonMain.aws.sdk.kotlin.services.neptunedata.model.GetPropertygraphStreamRequest.kt Maven / Gradle / Ivy

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

package aws.sdk.kotlin.services.neptunedata.model

import aws.smithy.kotlin.runtime.SdkDsl

public class GetPropertygraphStreamRequest private constructor(builder: Builder) {
    /**
     * The commit number of the starting record to read from the change-log stream. This parameter is required when `iteratorType` is`AT_SEQUENCE_NUMBER` or `AFTER_SEQUENCE_NUMBER`, and ignored when `iteratorType` is `TRIM_HORIZON` or `LATEST`.
     */
    public val commitNum: kotlin.Long? = builder.commitNum
    /**
     * If set to TRUE, Neptune compresses the response using gzip encoding.
     */
    public val encoding: aws.sdk.kotlin.services.neptunedata.model.Encoding? = builder.encoding
    /**
     * Can be one of:
     * + `AT_SEQUENCE_NUMBER` – Indicates that reading should start from the event sequence number specified jointly by the `commitNum` and `opNum` parameters.
     * + `AFTER_SEQUENCE_NUMBER` – Indicates that reading should start right after the event sequence number specified jointly by the `commitNum` and `opNum` parameters.
     * + `TRIM_HORIZON` – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.
     * + `LATEST` – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.
     */
    public val iteratorType: aws.sdk.kotlin.services.neptunedata.model.IteratorType? = builder.iteratorType
    /**
     * Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the `limit` parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.
     *
     * The range for `limit` is 1 to 100,000, with a default of 10.
     */
    public val limit: kotlin.Long? = builder.limit
    /**
     * The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is `1`.
     */
    public val opNum: kotlin.Long? = builder.opNum

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

    override fun toString(): kotlin.String = buildString {
        append("GetPropertygraphStreamRequest(")
        append("commitNum=$commitNum,")
        append("encoding=$encoding,")
        append("iteratorType=$iteratorType,")
        append("limit=$limit,")
        append("opNum=$opNum")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = commitNum?.hashCode() ?: 0
        result = 31 * result + (encoding?.hashCode() ?: 0)
        result = 31 * result + (iteratorType?.hashCode() ?: 0)
        result = 31 * result + (limit?.hashCode() ?: 0)
        result = 31 * result + (opNum?.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 GetPropertygraphStreamRequest

        if (commitNum != other.commitNum) return false
        if (encoding != other.encoding) return false
        if (iteratorType != other.iteratorType) return false
        if (limit != other.limit) return false
        if (opNum != other.opNum) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The commit number of the starting record to read from the change-log stream. This parameter is required when `iteratorType` is`AT_SEQUENCE_NUMBER` or `AFTER_SEQUENCE_NUMBER`, and ignored when `iteratorType` is `TRIM_HORIZON` or `LATEST`.
         */
        public var commitNum: kotlin.Long? = null
        /**
         * If set to TRUE, Neptune compresses the response using gzip encoding.
         */
        public var encoding: aws.sdk.kotlin.services.neptunedata.model.Encoding? = null
        /**
         * Can be one of:
         * + `AT_SEQUENCE_NUMBER` – Indicates that reading should start from the event sequence number specified jointly by the `commitNum` and `opNum` parameters.
         * + `AFTER_SEQUENCE_NUMBER` – Indicates that reading should start right after the event sequence number specified jointly by the `commitNum` and `opNum` parameters.
         * + `TRIM_HORIZON` – Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.
         * + `LATEST` – Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.
         */
        public var iteratorType: aws.sdk.kotlin.services.neptunedata.model.IteratorType? = null
        /**
         * Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the `limit` parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.
         *
         * The range for `limit` is 1 to 100,000, with a default of 10.
         */
        public var limit: kotlin.Long? = null
        /**
         * The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is `1`.
         */
        public var opNum: kotlin.Long? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.neptunedata.model.GetPropertygraphStreamRequest) : this() {
            this.commitNum = x.commitNum
            this.encoding = x.encoding
            this.iteratorType = x.iteratorType
            this.limit = x.limit
            this.opNum = x.opNum
        }

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

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