org.cdk8s.plus31.MetricOptions Maven / Gradle / Ivy
package org.cdk8s.plus31;
/**
* Base options for a Metric.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-10-12T12:14:17.399Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.MetricOptions")
@software.amazon.jsii.Jsii.Proxy(MetricOptions.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface MetricOptions extends software.amazon.jsii.JsiiSerializable {
/**
* The name of the metric to scale on.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getName();
/**
* The target metric value that will trigger scaling.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull org.cdk8s.plus31.MetricTarget getTarget();
/**
* A selector to find a metric by label.
*
* When set, it is passed as an additional parameter to the metrics server
* for more specific metrics scoping.
*
* Default: - Just the metric 'name' will be used to gather metrics.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable org.cdk8s.plus31.LabelSelector getLabelSelector() {
return null;
}
/**
* @return a {@link Builder} of {@link MetricOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link MetricOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String name;
org.cdk8s.plus31.MetricTarget target;
org.cdk8s.plus31.LabelSelector labelSelector;
/**
* Sets the value of {@link MetricOptions#getName}
* @param name The name of the metric to scale on. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder name(java.lang.String name) {
this.name = name;
return this;
}
/**
* Sets the value of {@link MetricOptions#getTarget}
* @param target The target metric value that will trigger scaling. This parameter is required.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder target(org.cdk8s.plus31.MetricTarget target) {
this.target = target;
return this;
}
/**
* Sets the value of {@link MetricOptions#getLabelSelector}
* @param labelSelector A selector to find a metric by label.
* When set, it is passed as an additional parameter to the metrics server
* for more specific metrics scoping.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder labelSelector(org.cdk8s.plus31.LabelSelector labelSelector) {
this.labelSelector = labelSelector;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link MetricOptions}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public MetricOptions build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link MetricOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements MetricOptions {
private final java.lang.String name;
private final org.cdk8s.plus31.MetricTarget target;
private final org.cdk8s.plus31.LabelSelector labelSelector;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.name = software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.target = software.amazon.jsii.Kernel.get(this, "target", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.MetricTarget.class));
this.labelSelector = software.amazon.jsii.Kernel.get(this, "labelSelector", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.LabelSelector.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.name = java.util.Objects.requireNonNull(builder.name, "name is required");
this.target = java.util.Objects.requireNonNull(builder.target, "target is required");
this.labelSelector = builder.labelSelector;
}
@Override
public final java.lang.String getName() {
return this.name;
}
@Override
public final org.cdk8s.plus31.MetricTarget getTarget() {
return this.target;
}
@Override
public final org.cdk8s.plus31.LabelSelector getLabelSelector() {
return this.labelSelector;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("name", om.valueToTree(this.getName()));
data.set("target", om.valueToTree(this.getTarget()));
if (this.getLabelSelector() != null) {
data.set("labelSelector", om.valueToTree(this.getLabelSelector()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-31.MetricOptions"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
MetricOptions.Jsii$Proxy that = (MetricOptions.Jsii$Proxy) o;
if (!name.equals(that.name)) return false;
if (!target.equals(that.target)) return false;
return this.labelSelector != null ? this.labelSelector.equals(that.labelSelector) : that.labelSelector == null;
}
@Override
public final int hashCode() {
int result = this.name.hashCode();
result = 31 * result + (this.target.hashCode());
result = 31 * result + (this.labelSelector != null ? this.labelSelector.hashCode() : 0);
return result;
}
}
}