io.streamthoughts.jikkou.kafka.model.KafkaClientQuotaConfigs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jikkou-extension-kafka Show documentation
There is a newer version: 0.31.0
Show newest version
/*
 * Copyright 2023 StreamThoughts.
 *
 * 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 io.streamthoughts.jikkou.kafka.model;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.streamthoughts.jikkou.api.model.annotations.Description;
import java.beans.ConstructorProperties;
import java.util.Objects;
import java.util.Optional;
import java.util.OptionalDouble;
import lombok.Builder;
import lombok.With;


/**
 * Client Quota Limits
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
@Builder(builderMethodName = "builder", toBuilder = true, setterPrefix = "with")
@With
@Description("Client quota configuration")
@JsonPropertyOrder({
    "producerByteRate",
    "consumerByteRate",
    "requestPercentage"
})
@JsonDeserialize(using = com.fasterxml.jackson.databind.JsonDeserializer.None.class)
public class KafkaClientQuotaConfigs {

    /**
     * The quota in bytes for restricting data production.
     */
    @JsonProperty("producerByteRate")
    @JsonPropertyDescription("The quota in bytes for restricting data production.")
    private OptionalDouble producerByteRate;
    /**
     * The quota in bytes for restricting data consumption.
     */
    @JsonProperty("consumerByteRate")
    @JsonPropertyDescription("The quota in bytes for restricting data consumption.")
    private OptionalDouble consumerByteRate ;

    /**
     * The quota in percentage (%) of total requests.
     */
    @JsonProperty("requestPercentage")
    @JsonPropertyDescription("The quota in percentage (%) of total requests.")
    private OptionalDouble requestPercentage;

    /**
     * No args constructor for use in serialization
     * 
     */
    public KafkaClientQuotaConfigs() {
    }

    /**
     * Creates a new {@link KafkaClientQuotaConfigs} instance.
     *
     * @param producerByteRate {@link #producerByteRate}.
     * @param consumerByteRate {@link #consumerByteRate}.
     * @param requestPercentage {@link #requestPercentage}.
     */
    @ConstructorProperties({
        "producerByteRate",
        "consumerByteRate",
        "requestPercentage"
    })
    public KafkaClientQuotaConfigs(OptionalDouble producerByteRate,
                                   OptionalDouble consumerByteRate,
                                   OptionalDouble requestPercentage) {
        super();
        this.producerByteRate = Optional.ofNullable(producerByteRate).orElse(OptionalDouble.empty());
        this.consumerByteRate = Optional.ofNullable(consumerByteRate).orElse(OptionalDouble.empty());
        this.requestPercentage = Optional.ofNullable(requestPercentage).orElse(OptionalDouble.empty());
    }

    /**
     * The quota in bytes for restricting data production.
     * 
     */
    @JsonProperty("producerByteRate")
    public OptionalDouble getProducerByteRate() {
        return producerByteRate;
    }

    /**
     * The quota in bytes for restricting data consumption.
     * 
     */
    @JsonProperty("consumerByteRate")
    public OptionalDouble getConsumerByteRate() {
        return consumerByteRate;
    }

    /**
     * The quota in percentage (%) of total requests.
     * 
     */
    @JsonProperty("requestPercentage")
    public OptionalDouble getRequestPercentage() {
        return requestPercentage;
    }

    /** {@inheritDoc} **/
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        KafkaClientQuotaConfigs that = (KafkaClientQuotaConfigs) o;
        return Objects.equals(producerByteRate, that.producerByteRate) && Objects.equals(consumerByteRate, that.consumerByteRate) && Objects.equals(requestPercentage, that.requestPercentage);
    }

    /** {@inheritDoc} **/
    @Override
    public int hashCode() {
        return Objects.hash(producerByteRate, consumerByteRate, requestPercentage);
    }

    /** {@inheritDoc} **/
    @Override
    public String toString() {
        return "KafkaClientQuotaConfigs{" +
                "producerByteRate=" + producerByteRate +
                ", consumerByteRate=" + consumerByteRate +
                ", requestPercentage=" + requestPercentage +
                '}';
    }
}