org.apache.kafka.streams.processor.TaskMetadata Maven / Gradle / Ivy

/*
 * 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.processor;

import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.streams.KafkaStreams;

import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;

/**
 * Represents the state of a single task running within a {@link KafkaStreams} application.
 * @deprecated since 3.0, use {@link org.apache.kafka.streams.TaskMetadata} instead.
 */
@Deprecated
public class TaskMetadata {

    private final String taskId;

    private final Set topicPartitions;

    private final Map committedOffsets;

    private final Map endOffsets;

    private final Optional timeCurrentIdlingStarted;

    public TaskMetadata(final String taskId,
                        final Set topicPartitions,
                        final Map committedOffsets,
                        final Map endOffsets,
                        final Optional timeCurrentIdlingStarted) {
        this.taskId = taskId;
        this.topicPartitions = Collections.unmodifiableSet(topicPartitions);
        this.committedOffsets = Collections.unmodifiableMap(committedOffsets);
        this.endOffsets = Collections.unmodifiableMap(endOffsets);
        this.timeCurrentIdlingStarted = timeCurrentIdlingStarted;
    }

    /**
     * @return the basic task metadata such as subtopology and partition id
     */
    public String taskId() {
        return taskId;
    }

    public Set topicPartitions() {
        return topicPartitions;
    }

    /**
     * This function will return a map of TopicPartitions and the highest committed offset seen so far
     */
    public Map committedOffsets() {
        return committedOffsets;
    }

    /**
     * This function will return a map of TopicPartitions and the highest offset seen so far in the Topic
     */
    public Map endOffsets() {
        return endOffsets;
    }

    /**
     * This function will return the time task idling started, if the task is not currently idling it will return empty
     */
    public Optional timeCurrentIdlingStarted() {
        return timeCurrentIdlingStarted;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        final TaskMetadata that = (TaskMetadata) o;
        return Objects.equals(taskId, that.taskId) &&
               Objects.equals(topicPartitions, that.topicPartitions);
    }

    @Override
    public int hashCode() {
        return Objects.hash(taskId, topicPartitions);
    }

    @Override
    public String toString() {
        return "TaskMetadata{" +
                "taskId=" + taskId +
                ", topicPartitions=" + topicPartitions +
                ", committedOffsets=" + committedOffsets +
                ", endOffsets=" + endOffsets +
                ", timeCurrentIdlingStarted=" + timeCurrentIdlingStarted +
                '}';
    }
}