com.oracle.bmc.apigateway.model.RateLimitingPolicy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-apigateway Show documentation
Show all versions of oci-java-sdk-apigateway Show documentation
This project contains the SDK used for Oracle Cloud Infrastructure Apigateway
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.apigateway.model;
/**
* Limit the number of requests that should be handled for the specified window using a specfic key.
*
* Note: Objects should always be created or deserialized using the {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #equals(Object)} methods are implemented to take the explicitly set
* fields into account. The constructor, on the other hand, does not take the explicitly set fields
* into account (since the constructor cannot distinguish explicit {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
builder = RateLimitingPolicy.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class RateLimitingPolicy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({"rateInRequestsPerSecond", "rateKey"})
public RateLimitingPolicy(Integer rateInRequestsPerSecond, RateKey rateKey) {
super();
this.rateInRequestsPerSecond = rateInRequestsPerSecond;
this.rateKey = rateKey;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/** The maximum number of requests per second to allow. */
@com.fasterxml.jackson.annotation.JsonProperty("rateInRequestsPerSecond")
private Integer rateInRequestsPerSecond;
/**
* The maximum number of requests per second to allow.
*
* @param rateInRequestsPerSecond the value to set
* @return this builder
*/
public Builder rateInRequestsPerSecond(Integer rateInRequestsPerSecond) {
this.rateInRequestsPerSecond = rateInRequestsPerSecond;
this.__explicitlySet__.add("rateInRequestsPerSecond");
return this;
}
/** The key used to group requests together. */
@com.fasterxml.jackson.annotation.JsonProperty("rateKey")
private RateKey rateKey;
/**
* The key used to group requests together.
*
* @param rateKey the value to set
* @return this builder
*/
public Builder rateKey(RateKey rateKey) {
this.rateKey = rateKey;
this.__explicitlySet__.add("rateKey");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public RateLimitingPolicy build() {
RateLimitingPolicy model =
new RateLimitingPolicy(this.rateInRequestsPerSecond, this.rateKey);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(RateLimitingPolicy model) {
if (model.wasPropertyExplicitlySet("rateInRequestsPerSecond")) {
this.rateInRequestsPerSecond(model.getRateInRequestsPerSecond());
}
if (model.wasPropertyExplicitlySet("rateKey")) {
this.rateKey(model.getRateKey());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/** The maximum number of requests per second to allow. */
@com.fasterxml.jackson.annotation.JsonProperty("rateInRequestsPerSecond")
private final Integer rateInRequestsPerSecond;
/**
* The maximum number of requests per second to allow.
*
* @return the value
*/
public Integer getRateInRequestsPerSecond() {
return rateInRequestsPerSecond;
}
/** The key used to group requests together. */
public enum RateKey implements com.oracle.bmc.http.internal.BmcEnum {
ClientIp("CLIENT_IP"),
Total("TOTAL"),
/**
* This value is used if a service returns a value for this enum that is not recognized by
* this version of the SDK.
*/
UnknownEnumValue(null);
private static final org.slf4j.Logger LOG =
org.slf4j.LoggerFactory.getLogger(RateKey.class);
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (RateKey v : RateKey.values()) {
if (v != UnknownEnumValue) {
map.put(v.getValue(), v);
}
}
}
RateKey(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static RateKey create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
LOG.warn(
"Received unknown value '{}' for enum 'RateKey', returning UnknownEnumValue",
key);
return UnknownEnumValue;
}
};
/** The key used to group requests together. */
@com.fasterxml.jackson.annotation.JsonProperty("rateKey")
private final RateKey rateKey;
/**
* The key used to group requests together.
*
* @return the value
*/
public RateKey getRateKey() {
return rateKey;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("RateLimitingPolicy(");
sb.append("super=").append(super.toString());
sb.append("rateInRequestsPerSecond=").append(String.valueOf(this.rateInRequestsPerSecond));
sb.append(", rateKey=").append(String.valueOf(this.rateKey));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof RateLimitingPolicy)) {
return false;
}
RateLimitingPolicy other = (RateLimitingPolicy) o;
return java.util.Objects.equals(this.rateInRequestsPerSecond, other.rateInRequestsPerSecond)
&& java.util.Objects.equals(this.rateKey, other.rateKey)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result =
(result * PRIME)
+ (this.rateInRequestsPerSecond == null
? 43
: this.rateInRequestsPerSecond.hashCode());
result = (result * PRIME) + (this.rateKey == null ? 43 : this.rateKey.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy