software.amazon.awssdk.services.codedeploy.model.AlarmConfiguration Maven / Gradle / Ivy
Show all versions of codedeploy Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.services.codedeploy.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Information about alarms associated with a deployment or deployment group.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AlarmConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("enabled").getter(getter(AlarmConfiguration::enabled)).setter(setter(Builder::enabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("enabled").build()).build();
private static final SdkField IGNORE_POLL_ALARM_FAILURE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ignorePollAlarmFailure").getter(getter(AlarmConfiguration::ignorePollAlarmFailure))
.setter(setter(Builder::ignorePollAlarmFailure))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ignorePollAlarmFailure").build())
.build();
private static final SdkField> ALARMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("alarms")
.getter(getter(AlarmConfiguration::alarms))
.setter(setter(Builder::alarms))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("alarms").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Alarm::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENABLED_FIELD,
IGNORE_POLL_ALARM_FAILURE_FIELD, ALARMS_FIELD));
private static final long serialVersionUID = 1L;
private final Boolean enabled;
private final Boolean ignorePollAlarmFailure;
private final List alarms;
private AlarmConfiguration(BuilderImpl builder) {
this.enabled = builder.enabled;
this.ignorePollAlarmFailure = builder.ignorePollAlarmFailure;
this.alarms = builder.alarms;
}
/**
*
* Indicates whether the alarm configuration is enabled.
*
*
* @return Indicates whether the alarm configuration is enabled.
*/
public final Boolean enabled() {
return enabled;
}
/**
*
* Indicates whether a deployment should continue if information about the current state of alarms cannot be
* retrieved from Amazon CloudWatch. The default value is false.
*
*
* -
*
* true: The deployment proceeds even if alarm status information can't be retrieved from Amazon
* CloudWatch.
*
*
* -
*
* false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
*
*
*
*
* @return Indicates whether a deployment should continue if information about the current state of alarms cannot be
* retrieved from Amazon CloudWatch. The default value is false.
*
* -
*
* true: The deployment proceeds even if alarm status information can't be retrieved from
* Amazon CloudWatch.
*
*
* -
*
* false: The deployment stops if alarm status information can't be retrieved from Amazon
* CloudWatch.
*
*
*/
public final Boolean ignorePollAlarmFailure() {
return ignorePollAlarmFailure;
}
/**
* For responses, this returns true if the service returned a value for the Alarms property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasAlarms() {
return alarms != null && !(alarms instanceof SdkAutoConstructList);
}
/**
*
* A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasAlarms} method.
*
*
* @return A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
*/
public final List alarms() {
return alarms;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(enabled());
hashCode = 31 * hashCode + Objects.hashCode(ignorePollAlarmFailure());
hashCode = 31 * hashCode + Objects.hashCode(hasAlarms() ? alarms() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AlarmConfiguration)) {
return false;
}
AlarmConfiguration other = (AlarmConfiguration) obj;
return Objects.equals(enabled(), other.enabled())
&& Objects.equals(ignorePollAlarmFailure(), other.ignorePollAlarmFailure()) && hasAlarms() == other.hasAlarms()
&& Objects.equals(alarms(), other.alarms());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("AlarmConfiguration").add("Enabled", enabled())
.add("IgnorePollAlarmFailure", ignorePollAlarmFailure()).add("Alarms", hasAlarms() ? alarms() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "enabled":
return Optional.ofNullable(clazz.cast(enabled()));
case "ignorePollAlarmFailure":
return Optional.ofNullable(clazz.cast(ignorePollAlarmFailure()));
case "alarms":
return Optional.ofNullable(clazz.cast(alarms()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AlarmConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Indicates whether the alarm configuration is enabled.
*
*
* @param enabled
* Indicates whether the alarm configuration is enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enabled(Boolean enabled);
/**
*
* Indicates whether a deployment should continue if information about the current state of alarms cannot be
* retrieved from Amazon CloudWatch. The default value is false.
*
*
* -
*
* true: The deployment proceeds even if alarm status information can't be retrieved from Amazon
* CloudWatch.
*
*
* -
*
* false: The deployment stops if alarm status information can't be retrieved from Amazon
* CloudWatch.
*
*
*
*
* @param ignorePollAlarmFailure
* Indicates whether a deployment should continue if information about the current state of alarms cannot
* be retrieved from Amazon CloudWatch. The default value is false.
*
* -
*
* true: The deployment proceeds even if alarm status information can't be retrieved from
* Amazon CloudWatch.
*
*
* -
*
* false: The deployment stops if alarm status information can't be retrieved from Amazon
* CloudWatch.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ignorePollAlarmFailure(Boolean ignorePollAlarmFailure);
/**
*
* A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
*
*
* @param alarms
* A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be
* added.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alarms(Collection alarms);
/**
*
* A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
*
*
* @param alarms
* A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be
* added.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alarms(Alarm... alarms);
/**
*
* A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.codedeploy.model.Alarm.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.codedeploy.model.Alarm#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.codedeploy.model.Alarm.Builder#build()} is called immediately and its
* result is passed to {@link #alarms(List)}.
*
* @param alarms
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.codedeploy.model.Alarm.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #alarms(java.util.Collection)
*/
Builder alarms(Consumer... alarms);
}
static final class BuilderImpl implements Builder {
private Boolean enabled;
private Boolean ignorePollAlarmFailure;
private List alarms = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AlarmConfiguration model) {
enabled(model.enabled);
ignorePollAlarmFailure(model.ignorePollAlarmFailure);
alarms(model.alarms);
}
public final Boolean getEnabled() {
return enabled;
}
public final void setEnabled(Boolean enabled) {
this.enabled = enabled;
}
@Override
public final Builder enabled(Boolean enabled) {
this.enabled = enabled;
return this;
}
public final Boolean getIgnorePollAlarmFailure() {
return ignorePollAlarmFailure;
}
public final void setIgnorePollAlarmFailure(Boolean ignorePollAlarmFailure) {
this.ignorePollAlarmFailure = ignorePollAlarmFailure;
}
@Override
public final Builder ignorePollAlarmFailure(Boolean ignorePollAlarmFailure) {
this.ignorePollAlarmFailure = ignorePollAlarmFailure;
return this;
}
public final List getAlarms() {
List result = AlarmListCopier.copyToBuilder(this.alarms);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAlarms(Collection alarms) {
this.alarms = AlarmListCopier.copyFromBuilder(alarms);
}
@Override
public final Builder alarms(Collection alarms) {
this.alarms = AlarmListCopier.copy(alarms);
return this;
}
@Override
@SafeVarargs
public final Builder alarms(Alarm... alarms) {
alarms(Arrays.asList(alarms));
return this;
}
@Override
@SafeVarargs
public final Builder alarms(Consumer... alarms) {
alarms(Stream.of(alarms).map(c -> Alarm.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public AlarmConfiguration build() {
return new AlarmConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}