org.apache.kafka.streams.state.DslWindowParams Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kafka-streams Show documentation
There is a newer version: 3.8.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.kafka.streams.state;

import java.time.Duration;
import java.util.Objects;
import org.apache.kafka.streams.kstream.EmitStrategy;

/**
 * {@code DslWindowParams} is a wrapper class for all parameters that function
 * as inputs to {@link DslStoreSuppliers#windowStore(DslWindowParams)}.
 */
public class DslWindowParams {

    private final String name;
    private final Duration retentionPeriod;
    private final Duration windowSize;
    private final boolean retainDuplicates;
    private final EmitStrategy emitStrategy;
    private final boolean isSlidingWindow;
    private final boolean isTimestamped;

    /**
     * @param name             name of the store (cannot be {@code null})
     * @param retentionPeriod  length of time to retain data in the store (cannot be negative)
     *                         (note that the retention period must be at least long enough to contain the
     *                         windowed data's entire life cycle, from window-start through window-end,
     *                         and for the entire grace period)
     * @param windowSize       size of the windows (cannot be negative)
     * @param retainDuplicates whether to retain duplicates. Turning this on will automatically disable
     *                         caching and means that null values will be ignored.
     * @param emitStrategy     defines how to emit results
     * @param isSlidingWindow  whether the requested store is a sliding window
     * @param isTimestamped    whether the requested store should be timestamped (see {@link TimestampedWindowStore}
     */
    public DslWindowParams(
            final String name,
            final Duration retentionPeriod,
            final Duration windowSize,
            final boolean retainDuplicates,
            final EmitStrategy emitStrategy,
            final boolean isSlidingWindow,
            final boolean isTimestamped
    ) {
        this.isTimestamped = isTimestamped;
        Objects.requireNonNull(name);
        this.name = name;
        this.retentionPeriod = retentionPeriod;
        this.windowSize = windowSize;
        this.retainDuplicates = retainDuplicates;
        this.emitStrategy = emitStrategy;
        this.isSlidingWindow = isSlidingWindow;
    }

    public String name() {
        return name;
    }

    public Duration retentionPeriod() {
        return retentionPeriod;
    }

    public Duration windowSize() {
        return windowSize;
    }

    public boolean retainDuplicates() {
        return retainDuplicates;
    }

    public EmitStrategy emitStrategy() {
        return emitStrategy;
    }

    public boolean isSlidingWindow() {
        return isSlidingWindow;
    }

    public boolean isTimestamped() {
        return isTimestamped;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        final DslWindowParams that = (DslWindowParams) o;
        return retainDuplicates == that.retainDuplicates
                && Objects.equals(name, that.name)
                && Objects.equals(retentionPeriod, that.retentionPeriod)
                && Objects.equals(windowSize, that.windowSize)
                && Objects.equals(emitStrategy, that.emitStrategy)
                && Objects.equals(isSlidingWindow, that.isSlidingWindow)
                && Objects.equals(isTimestamped, that.isTimestamped);
    }

    @Override
    public int hashCode() {
        return Objects.hash(
                name,
                retentionPeriod,
                windowSize,
                retainDuplicates,
                emitStrategy,
                isSlidingWindow,
                isTimestamped
        );
    }

    @Override
    public String toString() {
        return "DslWindowParams{" +
                "name='" + name + '\'' +
                ", retentionPeriod=" + retentionPeriod +
                ", windowSize=" + windowSize +
                ", retainDuplicates=" + retainDuplicates +
                ", emitStrategy=" + emitStrategy +
                ", isSlidingWindow=" + isSlidingWindow +
                ", isTimestamped=" + isTimestamped +
                '}';
    }
}