com.couchbase.client.kotlin.view.ViewScanConsistency.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-client Show documentation

The official Couchbase Kotlin SDK

The newest version!

/*
 * Copyright 2021 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.couchbase.client.kotlin.view

import com.couchbase.client.core.util.UrlQueryStringBuilder

public sealed class ViewScanConsistency(internal val encoded: String) {
    private object NotBounded : ViewScanConsistency("ok")
    private object RequestPlus : ViewScanConsistency("false")
    private object UpdateAfter : ViewScanConsistency("update_after")

    public companion object {
        public fun notBounded(): ViewScanConsistency = NotBounded
        public fun requestPlus(): ViewScanConsistency = RequestPlus
        public fun updateAfter(): ViewScanConsistency = UpdateAfter
    }

    internal fun inject(params: UrlQueryStringBuilder) {
        params.set("stale", encoded)
    }

    override fun toString(): String {
        return this::class.simpleName!!
    }
}