org.apache.druid.indexing.overlord.SegmentPublishResult.java Source code

Introduction

Here is the source code for org.apache.druid.indexing.overlord.SegmentPublishResult.java

Source

/*
 * 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.druid.indexing.overlord;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableSet;
import org.apache.druid.timeline.DataSegment;

import java.util.Objects;
import java.util.Set;

/**
 * Result of an operation that attempts to publish segments. Indicates the set of segments actually published
 * and whether or not the transaction was a success.
 *
 * If "success" is false then the segments set will be empty.
 *
 * It's possible for the segments set to be empty even if "success" is true, since the segments set only
 * includes segments actually published as part of the transaction. The requested segments could have been
 * published by a different transaction (e.g. in the case of replica sets) and this one would still succeed.
 */
public class SegmentPublishResult {
    private final Set<DataSegment> segments;
    private final boolean success;

    public static SegmentPublishResult fail() {
        return new SegmentPublishResult(ImmutableSet.of(), false);
    }

    @JsonCreator
    public SegmentPublishResult(@JsonProperty("segments") Set<DataSegment> segments,
            @JsonProperty("success") boolean success) {
        this.segments = Preconditions.checkNotNull(segments, "segments");
        this.success = success;

        if (!success) {
            Preconditions.checkArgument(segments.isEmpty(), "segments must be empty for unsuccessful publishes");
        }
    }

    @JsonProperty
    public Set<DataSegment> getSegments() {
        return segments;
    }

    @JsonProperty
    public boolean isSuccess() {
        return success;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        SegmentPublishResult that = (SegmentPublishResult) o;
        return success == that.success && Objects.equals(segments, that.segments);
    }

    @Override
    public int hashCode() {
        return Objects.hash(segments, success);
    }

    @Override
    public String toString() {
        return "SegmentPublishResult{" + "segments=" + segments + ", success=" + success + '}';
    }
}