ResourceDescription.java

/**
 * Copyright 2016 Yahoo 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.yahoo.pulsar.broker.loadbalance;

import java.util.Map;

import com.yahoo.pulsar.common.policies.data.loadbalancer.ResourceUsage;

/*
    ResourceDescription is an abstraction to represent resources like memory, cpu, network and io combined;
    resource usage can be added, removed or usage in percent can be obtained.
 */
public abstract class ResourceDescription implements Comparable<ResourceDescription> {

    public abstract void removeUsage(ResourceDescription rd);

    public abstract void addUsage(ResourceDescription rd);

    public abstract int getUsagePct();

    public abstract Map<String, ResourceUsage> getResourceUsage();
}