com.oracle.bmc.loadbalancer.model.LoadBalancerHealth Maven / Gradle / Ivy
Show all versions of oci-java-sdk-loadbalancer Show documentation
/**
* 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.loadbalancer.model;
/**
* The health status details for the specified load balancer.
*
* This object does not explicitly enumerate backend sets with a status of {@code OK}. However,
* they are included in the {@code totalBackendSetCount} sum.
* 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: 20170115")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
builder = LoadBalancerHealth.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class LoadBalancerHealth
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"status",
"warningStateBackendSetNames",
"criticalStateBackendSetNames",
"unknownStateBackendSetNames",
"totalBackendSetCount"
})
public LoadBalancerHealth(
Status status,
java.util.List warningStateBackendSetNames,
java.util.List criticalStateBackendSetNames,
java.util.List unknownStateBackendSetNames,
Integer totalBackendSetCount) {
super();
this.status = status;
this.warningStateBackendSetNames = warningStateBackendSetNames;
this.criticalStateBackendSetNames = criticalStateBackendSetNames;
this.unknownStateBackendSetNames = unknownStateBackendSetNames;
this.totalBackendSetCount = totalBackendSetCount;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/**
* The overall health status of the load balancer.
*
* **OK:** All backend sets associated with the load balancer return a status of {@code
* OK}.
*
*
**WARNING:** At least one of the backend sets associated with the load balancer
* returns a status of {@code WARNING}, no backend sets return a status of {@code CRITICAL},
* and the load balancer life cycle state is {@code ACTIVE}.
*
*
**CRITICAL:** One or more of the backend sets associated with the load balancer return
* a status of {@code CRITICAL}.
*
*
**UNKNOWN:** If any one of the following conditions is true:
*
*
The load balancer life cycle state is not {@code ACTIVE}.
*
*
No backend sets are defined for the load balancer.
*
*
More than half of the backend sets associated with the load balancer return a status
* of {@code UNKNOWN}, none of the backend sets return a status of {@code WARNING} or {@code
* CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
*
*
The system could not retrieve metrics for any reason.
*/
@com.fasterxml.jackson.annotation.JsonProperty("status")
private Status status;
/**
* The overall health status of the load balancer.
*
*
**OK:** All backend sets associated with the load balancer return a status of {@code
* OK}.
*
*
**WARNING:** At least one of the backend sets associated with the load balancer
* returns a status of {@code WARNING}, no backend sets return a status of {@code CRITICAL},
* and the load balancer life cycle state is {@code ACTIVE}.
*
*
**CRITICAL:** One or more of the backend sets associated with the load balancer return
* a status of {@code CRITICAL}.
*
*
**UNKNOWN:** If any one of the following conditions is true:
*
*
The load balancer life cycle state is not {@code ACTIVE}.
*
*
No backend sets are defined for the load balancer.
*
*
More than half of the backend sets associated with the load balancer return a status
* of {@code UNKNOWN}, none of the backend sets return a status of {@code WARNING} or {@code
* CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
*
*
The system could not retrieve metrics for any reason.
*
* @param status the value to set
* @return this builder
*/
public Builder status(Status status) {
this.status = status;
this.__explicitlySet__.add("status");
return this;
}
/**
* A list of backend sets that are currently in the {@code WARNING} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
*
Example: {@code example_backend_set3}
*/
@com.fasterxml.jackson.annotation.JsonProperty("warningStateBackendSetNames")
private java.util.List warningStateBackendSetNames;
/**
* A list of backend sets that are currently in the {@code WARNING} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set3}
*
* @param warningStateBackendSetNames the value to set
* @return this builder
*/
public Builder warningStateBackendSetNames(
java.util.List warningStateBackendSetNames) {
this.warningStateBackendSetNames = warningStateBackendSetNames;
this.__explicitlySet__.add("warningStateBackendSetNames");
return this;
}
/**
* A list of backend sets that are currently in the {@code CRITICAL} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set}
*/
@com.fasterxml.jackson.annotation.JsonProperty("criticalStateBackendSetNames")
private java.util.List criticalStateBackendSetNames;
/**
* A list of backend sets that are currently in the {@code CRITICAL} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set}
*
* @param criticalStateBackendSetNames the value to set
* @return this builder
*/
public Builder criticalStateBackendSetNames(
java.util.List criticalStateBackendSetNames) {
this.criticalStateBackendSetNames = criticalStateBackendSetNames;
this.__explicitlySet__.add("criticalStateBackendSetNames");
return this;
}
/**
* A list of backend sets that are currently in the {@code UNKNOWN} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set2}
*/
@com.fasterxml.jackson.annotation.JsonProperty("unknownStateBackendSetNames")
private java.util.List unknownStateBackendSetNames;
/**
* A list of backend sets that are currently in the {@code UNKNOWN} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set2}
*
* @param unknownStateBackendSetNames the value to set
* @return this builder
*/
public Builder unknownStateBackendSetNames(
java.util.List unknownStateBackendSetNames) {
this.unknownStateBackendSetNames = unknownStateBackendSetNames;
this.__explicitlySet__.add("unknownStateBackendSetNames");
return this;
}
/**
* The total number of backend sets associated with this load balancer.
*
* Example: {@code 4}
*/
@com.fasterxml.jackson.annotation.JsonProperty("totalBackendSetCount")
private Integer totalBackendSetCount;
/**
* The total number of backend sets associated with this load balancer.
*
*
Example: {@code 4}
*
* @param totalBackendSetCount the value to set
* @return this builder
*/
public Builder totalBackendSetCount(Integer totalBackendSetCount) {
this.totalBackendSetCount = totalBackendSetCount;
this.__explicitlySet__.add("totalBackendSetCount");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public LoadBalancerHealth build() {
LoadBalancerHealth model =
new LoadBalancerHealth(
this.status,
this.warningStateBackendSetNames,
this.criticalStateBackendSetNames,
this.unknownStateBackendSetNames,
this.totalBackendSetCount);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(LoadBalancerHealth model) {
if (model.wasPropertyExplicitlySet("status")) {
this.status(model.getStatus());
}
if (model.wasPropertyExplicitlySet("warningStateBackendSetNames")) {
this.warningStateBackendSetNames(model.getWarningStateBackendSetNames());
}
if (model.wasPropertyExplicitlySet("criticalStateBackendSetNames")) {
this.criticalStateBackendSetNames(model.getCriticalStateBackendSetNames());
}
if (model.wasPropertyExplicitlySet("unknownStateBackendSetNames")) {
this.unknownStateBackendSetNames(model.getUnknownStateBackendSetNames());
}
if (model.wasPropertyExplicitlySet("totalBackendSetCount")) {
this.totalBackendSetCount(model.getTotalBackendSetCount());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/**
* The overall health status of the load balancer.
*
* **OK:** All backend sets associated with the load balancer return a status of {@code OK}.
*
*
**WARNING:** At least one of the backend sets associated with the load balancer returns a
* status of {@code WARNING}, no backend sets return a status of {@code CRITICAL}, and the load
* balancer life cycle state is {@code ACTIVE}.
*
*
**CRITICAL:** One or more of the backend sets associated with the load balancer return a
* status of {@code CRITICAL}.
*
*
**UNKNOWN:** If any one of the following conditions is true:
*
*
The load balancer life cycle state is not {@code ACTIVE}.
*
*
No backend sets are defined for the load balancer.
*
*
More than half of the backend sets associated with the load balancer return a status of
* {@code UNKNOWN}, none of the backend sets return a status of {@code WARNING} or {@code
* CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
*
*
The system could not retrieve metrics for any reason.
*/
public enum Status implements com.oracle.bmc.http.internal.BmcEnum {
Ok("OK"),
Warning("WARNING"),
Critical("CRITICAL"),
Unknown("UNKNOWN"),
/**
* 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(Status.class);
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (Status v : Status.values()) {
if (v != UnknownEnumValue) {
map.put(v.getValue(), v);
}
}
}
Status(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static Status create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
LOG.warn(
"Received unknown value '{}' for enum 'Status', returning UnknownEnumValue",
key);
return UnknownEnumValue;
}
};
/**
* The overall health status of the load balancer.
*
* **OK:** All backend sets associated with the load balancer return a status of {@code OK}.
*
*
**WARNING:** At least one of the backend sets associated with the load balancer returns a
* status of {@code WARNING}, no backend sets return a status of {@code CRITICAL}, and the load
* balancer life cycle state is {@code ACTIVE}.
*
*
**CRITICAL:** One or more of the backend sets associated with the load balancer return a
* status of {@code CRITICAL}.
*
*
**UNKNOWN:** If any one of the following conditions is true:
*
*
The load balancer life cycle state is not {@code ACTIVE}.
*
*
No backend sets are defined for the load balancer.
*
*
More than half of the backend sets associated with the load balancer return a status of
* {@code UNKNOWN}, none of the backend sets return a status of {@code WARNING} or {@code
* CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
*
*
The system could not retrieve metrics for any reason.
*/
@com.fasterxml.jackson.annotation.JsonProperty("status")
private final Status status;
/**
* The overall health status of the load balancer.
*
*
**OK:** All backend sets associated with the load balancer return a status of {@code OK}.
*
*
**WARNING:** At least one of the backend sets associated with the load balancer returns a
* status of {@code WARNING}, no backend sets return a status of {@code CRITICAL}, and the load
* balancer life cycle state is {@code ACTIVE}.
*
*
**CRITICAL:** One or more of the backend sets associated with the load balancer return a
* status of {@code CRITICAL}.
*
*
**UNKNOWN:** If any one of the following conditions is true:
*
*
The load balancer life cycle state is not {@code ACTIVE}.
*
*
No backend sets are defined for the load balancer.
*
*
More than half of the backend sets associated with the load balancer return a status of
* {@code UNKNOWN}, none of the backend sets return a status of {@code WARNING} or {@code
* CRITICAL}, and the load balancer life cycle state is {@code ACTIVE}.
*
*
The system could not retrieve metrics for any reason.
*
* @return the value
*/
public Status getStatus() {
return status;
}
/**
* A list of backend sets that are currently in the {@code WARNING} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
*
Example: {@code example_backend_set3}
*/
@com.fasterxml.jackson.annotation.JsonProperty("warningStateBackendSetNames")
private final java.util.List warningStateBackendSetNames;
/**
* A list of backend sets that are currently in the {@code WARNING} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set3}
*
* @return the value
*/
public java.util.List getWarningStateBackendSetNames() {
return warningStateBackendSetNames;
}
/**
* A list of backend sets that are currently in the {@code CRITICAL} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set}
*/
@com.fasterxml.jackson.annotation.JsonProperty("criticalStateBackendSetNames")
private final java.util.List criticalStateBackendSetNames;
/**
* A list of backend sets that are currently in the {@code CRITICAL} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set}
*
* @return the value
*/
public java.util.List getCriticalStateBackendSetNames() {
return criticalStateBackendSetNames;
}
/**
* A list of backend sets that are currently in the {@code UNKNOWN} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set2}
*/
@com.fasterxml.jackson.annotation.JsonProperty("unknownStateBackendSetNames")
private final java.util.List unknownStateBackendSetNames;
/**
* A list of backend sets that are currently in the {@code UNKNOWN} health state. The list
* identifies each backend set by the friendly name you assigned when you created it.
*
* Example: {@code example_backend_set2}
*
* @return the value
*/
public java.util.List getUnknownStateBackendSetNames() {
return unknownStateBackendSetNames;
}
/**
* The total number of backend sets associated with this load balancer.
*
* Example: {@code 4}
*/
@com.fasterxml.jackson.annotation.JsonProperty("totalBackendSetCount")
private final Integer totalBackendSetCount;
/**
* The total number of backend sets associated with this load balancer.
*
*
Example: {@code 4}
*
* @return the value
*/
public Integer getTotalBackendSetCount() {
return totalBackendSetCount;
}
@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("LoadBalancerHealth(");
sb.append("super=").append(super.toString());
sb.append("status=").append(String.valueOf(this.status));
sb.append(", warningStateBackendSetNames=")
.append(String.valueOf(this.warningStateBackendSetNames));
sb.append(", criticalStateBackendSetNames=")
.append(String.valueOf(this.criticalStateBackendSetNames));
sb.append(", unknownStateBackendSetNames=")
.append(String.valueOf(this.unknownStateBackendSetNames));
sb.append(", totalBackendSetCount=").append(String.valueOf(this.totalBackendSetCount));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof LoadBalancerHealth)) {
return false;
}
LoadBalancerHealth other = (LoadBalancerHealth) o;
return java.util.Objects.equals(this.status, other.status)
&& java.util.Objects.equals(
this.warningStateBackendSetNames, other.warningStateBackendSetNames)
&& java.util.Objects.equals(
this.criticalStateBackendSetNames, other.criticalStateBackendSetNames)
&& java.util.Objects.equals(
this.unknownStateBackendSetNames, other.unknownStateBackendSetNames)
&& java.util.Objects.equals(this.totalBackendSetCount, other.totalBackendSetCount)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.status == null ? 43 : this.status.hashCode());
result =
(result * PRIME)
+ (this.warningStateBackendSetNames == null
? 43
: this.warningStateBackendSetNames.hashCode());
result =
(result * PRIME)
+ (this.criticalStateBackendSetNames == null
? 43
: this.criticalStateBackendSetNames.hashCode());
result =
(result * PRIME)
+ (this.unknownStateBackendSetNames == null
? 43
: this.unknownStateBackendSetNames.hashCode());
result =
(result * PRIME)
+ (this.totalBackendSetCount == null
? 43
: this.totalBackendSetCount.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}