/*
 * 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.pulsar.broker.loadbalance.extensions.models;

import static org.apache.pulsar.broker.loadbalance.extensions.models.UnloadDecision.Label.Skip;
import static org.apache.pulsar.broker.loadbalance.extensions.models.UnloadDecision.Label.Success;
import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * Defines the information required to unload or transfer a service unit(e.g. bundle).
 */
@Data
@AllArgsConstructor
public class UnloadDecision {
    Unload unload;
    Label label;
    Reason reason;

    public enum Label {
        Success,
        Skip,
        Failure
    }
    public enum Reason {
        Overloaded,
        Underloaded,
        HitCount,
        NoBundles,
        CoolDown,
        OutDatedData,
        NoLoadData,
        NoBrokers,
        Admin,
        Unknown
    }

    public UnloadDecision() {
        unload = null;
        label = null;
        reason = null;
    }

    public void clear() {
        unload = null;
        label = null;
        reason = null;
    }

    public void skip(Reason reason) {
        label = Skip;
        this.reason = reason;
    }

    public void succeed(Reason reason) {
        this.label = Success;
        this.reason = reason;
    }

}
