software.amazon.awssdk.services.fms.model.PossibleRemediationAction Maven / Gradle / Ivy
Show all versions of fms 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.fms.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;
/**
*
* A list of remediation actions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PossibleRemediationAction implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(PossibleRemediationAction::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> ORDERED_REMEDIATION_ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OrderedRemediationActions")
.getter(getter(PossibleRemediationAction::orderedRemediationActions))
.setter(setter(Builder::orderedRemediationActions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OrderedRemediationActions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RemediationActionWithOrder::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField IS_DEFAULT_ACTION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IsDefaultAction").getter(getter(PossibleRemediationAction::isDefaultAction))
.setter(setter(Builder::isDefaultAction))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IsDefaultAction").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESCRIPTION_FIELD,
ORDERED_REMEDIATION_ACTIONS_FIELD, IS_DEFAULT_ACTION_FIELD));
private static final long serialVersionUID = 1L;
private final String description;
private final List orderedRemediationActions;
private final Boolean isDefaultAction;
private PossibleRemediationAction(BuilderImpl builder) {
this.description = builder.description;
this.orderedRemediationActions = builder.orderedRemediationActions;
this.isDefaultAction = builder.isDefaultAction;
}
/**
*
* A description of the list of remediation actions.
*
*
* @return A description of the list of remediation actions.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the OrderedRemediationActions 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 hasOrderedRemediationActions() {
return orderedRemediationActions != null && !(orderedRemediationActions instanceof SdkAutoConstructList);
}
/**
*
* The ordered list of remediation actions.
*
*
* 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 #hasOrderedRemediationActions} method.
*
*
* @return The ordered list of remediation actions.
*/
public final List orderedRemediationActions() {
return orderedRemediationActions;
}
/**
*
* Information about whether an action is taken by default.
*
*
* @return Information about whether an action is taken by default.
*/
public final Boolean isDefaultAction() {
return isDefaultAction;
}
@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(description());
hashCode = 31 * hashCode + Objects.hashCode(hasOrderedRemediationActions() ? orderedRemediationActions() : null);
hashCode = 31 * hashCode + Objects.hashCode(isDefaultAction());
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 PossibleRemediationAction)) {
return false;
}
PossibleRemediationAction other = (PossibleRemediationAction) obj;
return Objects.equals(description(), other.description())
&& hasOrderedRemediationActions() == other.hasOrderedRemediationActions()
&& Objects.equals(orderedRemediationActions(), other.orderedRemediationActions())
&& Objects.equals(isDefaultAction(), other.isDefaultAction());
}
/**
* 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("PossibleRemediationAction").add("Description", description())
.add("OrderedRemediationActions", hasOrderedRemediationActions() ? orderedRemediationActions() : null)
.add("IsDefaultAction", isDefaultAction()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "OrderedRemediationActions":
return Optional.ofNullable(clazz.cast(orderedRemediationActions()));
case "IsDefaultAction":
return Optional.ofNullable(clazz.cast(isDefaultAction()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PossibleRemediationAction) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A description of the list of remediation actions.
*
*
* @param description
* A description of the list of remediation actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The ordered list of remediation actions.
*
*
* @param orderedRemediationActions
* The ordered list of remediation actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder orderedRemediationActions(Collection orderedRemediationActions);
/**
*
* The ordered list of remediation actions.
*
*
* @param orderedRemediationActions
* The ordered list of remediation actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder orderedRemediationActions(RemediationActionWithOrder... orderedRemediationActions);
/**
*
* The ordered list of remediation actions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fms.model.RemediationActionWithOrder.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.fms.model.RemediationActionWithOrder#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.fms.model.RemediationActionWithOrder.Builder#build()} is called
* immediately and its result is passed to {@link #orderedRemediationActions(List)}.
*
* @param orderedRemediationActions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.fms.model.RemediationActionWithOrder.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #orderedRemediationActions(java.util.Collection)
*/
Builder orderedRemediationActions(Consumer... orderedRemediationActions);
/**
*
* Information about whether an action is taken by default.
*
*
* @param isDefaultAction
* Information about whether an action is taken by default.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder isDefaultAction(Boolean isDefaultAction);
}
static final class BuilderImpl implements Builder {
private String description;
private List orderedRemediationActions = DefaultSdkAutoConstructList.getInstance();
private Boolean isDefaultAction;
private BuilderImpl() {
}
private BuilderImpl(PossibleRemediationAction model) {
description(model.description);
orderedRemediationActions(model.orderedRemediationActions);
isDefaultAction(model.isDefaultAction);
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final List getOrderedRemediationActions() {
List result = OrderedRemediationActionsCopier
.copyToBuilder(this.orderedRemediationActions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOrderedRemediationActions(
Collection orderedRemediationActions) {
this.orderedRemediationActions = OrderedRemediationActionsCopier.copyFromBuilder(orderedRemediationActions);
}
@Override
public final Builder orderedRemediationActions(Collection orderedRemediationActions) {
this.orderedRemediationActions = OrderedRemediationActionsCopier.copy(orderedRemediationActions);
return this;
}
@Override
@SafeVarargs
public final Builder orderedRemediationActions(RemediationActionWithOrder... orderedRemediationActions) {
orderedRemediationActions(Arrays.asList(orderedRemediationActions));
return this;
}
@Override
@SafeVarargs
public final Builder orderedRemediationActions(Consumer... orderedRemediationActions) {
orderedRemediationActions(Stream.of(orderedRemediationActions)
.map(c -> RemediationActionWithOrder.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Boolean getIsDefaultAction() {
return isDefaultAction;
}
public final void setIsDefaultAction(Boolean isDefaultAction) {
this.isDefaultAction = isDefaultAction;
}
@Override
public final Builder isDefaultAction(Boolean isDefaultAction) {
this.isDefaultAction = isDefaultAction;
return this;
}
@Override
public PossibleRemediationAction build() {
return new PossibleRemediationAction(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}