software.amazon.awssdk.services.codegurusecurity.model.Remediation Maven / Gradle / Ivy
Show all versions of codegurusecurity 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.codegurusecurity.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 how to remediate a finding.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Remediation implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField RECOMMENDATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("recommendation")
.getter(getter(Remediation::recommendation)).setter(setter(Builder::recommendation))
.constructor(Recommendation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recommendation").build()).build();
private static final SdkField> SUGGESTED_FIXES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("suggestedFixes")
.getter(getter(Remediation::suggestedFixes))
.setter(setter(Builder::suggestedFixes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("suggestedFixes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SuggestedFix::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RECOMMENDATION_FIELD,
SUGGESTED_FIXES_FIELD));
private static final long serialVersionUID = 1L;
private final Recommendation recommendation;
private final List suggestedFixes;
private Remediation(BuilderImpl builder) {
this.recommendation = builder.recommendation;
this.suggestedFixes = builder.suggestedFixes;
}
/**
*
* An object that contains information about the recommended course of action to remediate a finding.
*
*
* @return An object that contains information about the recommended course of action to remediate a finding.
*/
public final Recommendation recommendation() {
return recommendation;
}
/**
* For responses, this returns true if the service returned a value for the SuggestedFixes 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 hasSuggestedFixes() {
return suggestedFixes != null && !(suggestedFixes instanceof SdkAutoConstructList);
}
/**
*
* A list of SuggestedFix objects. Each object contains information about a suggested code fix to
* remediate the finding.
*
*
* 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 #hasSuggestedFixes} method.
*
*
* @return A list of SuggestedFix objects. Each object contains information about a suggested code fix
* to remediate the finding.
*/
public final List suggestedFixes() {
return suggestedFixes;
}
@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(recommendation());
hashCode = 31 * hashCode + Objects.hashCode(hasSuggestedFixes() ? suggestedFixes() : 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 Remediation)) {
return false;
}
Remediation other = (Remediation) obj;
return Objects.equals(recommendation(), other.recommendation()) && hasSuggestedFixes() == other.hasSuggestedFixes()
&& Objects.equals(suggestedFixes(), other.suggestedFixes());
}
/**
* 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("Remediation").add("Recommendation", recommendation())
.add("SuggestedFixes", hasSuggestedFixes() ? suggestedFixes() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "recommendation":
return Optional.ofNullable(clazz.cast(recommendation()));
case "suggestedFixes":
return Optional.ofNullable(clazz.cast(suggestedFixes()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Remediation) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An object that contains information about the recommended course of action to remediate a finding.
*
*
* @param recommendation
* An object that contains information about the recommended course of action to remediate a finding.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder recommendation(Recommendation recommendation);
/**
*
* An object that contains information about the recommended course of action to remediate a finding.
*
* This is a convenience method that creates an instance of the {@link Recommendation.Builder} avoiding the need
* to create one manually via {@link Recommendation#builder()}.
*
*
* When the {@link Consumer} completes, {@link Recommendation.Builder#build()} is called immediately and its
* result is passed to {@link #recommendation(Recommendation)}.
*
* @param recommendation
* a consumer that will call methods on {@link Recommendation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #recommendation(Recommendation)
*/
default Builder recommendation(Consumer recommendation) {
return recommendation(Recommendation.builder().applyMutation(recommendation).build());
}
/**
*
* A list of SuggestedFix objects. Each object contains information about a suggested code fix to
* remediate the finding.
*
*
* @param suggestedFixes
* A list of SuggestedFix objects. Each object contains information about a suggested code
* fix to remediate the finding.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder suggestedFixes(Collection suggestedFixes);
/**
*
* A list of SuggestedFix objects. Each object contains information about a suggested code fix to
* remediate the finding.
*
*
* @param suggestedFixes
* A list of SuggestedFix objects. Each object contains information about a suggested code
* fix to remediate the finding.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder suggestedFixes(SuggestedFix... suggestedFixes);
/**
*
* A list of SuggestedFix objects. Each object contains information about a suggested code fix to
* remediate the finding.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.codegurusecurity.model.SuggestedFix.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.codegurusecurity.model.SuggestedFix#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.codegurusecurity.model.SuggestedFix.Builder#build()} is called
* immediately and its result is passed to {@link #suggestedFixes(List)}.
*
* @param suggestedFixes
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.codegurusecurity.model.SuggestedFix.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #suggestedFixes(java.util.Collection)
*/
Builder suggestedFixes(Consumer... suggestedFixes);
}
static final class BuilderImpl implements Builder {
private Recommendation recommendation;
private List suggestedFixes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Remediation model) {
recommendation(model.recommendation);
suggestedFixes(model.suggestedFixes);
}
public final Recommendation.Builder getRecommendation() {
return recommendation != null ? recommendation.toBuilder() : null;
}
public final void setRecommendation(Recommendation.BuilderImpl recommendation) {
this.recommendation = recommendation != null ? recommendation.build() : null;
}
@Override
public final Builder recommendation(Recommendation recommendation) {
this.recommendation = recommendation;
return this;
}
public final List getSuggestedFixes() {
List result = SuggestedFixesCopier.copyToBuilder(this.suggestedFixes);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSuggestedFixes(Collection suggestedFixes) {
this.suggestedFixes = SuggestedFixesCopier.copyFromBuilder(suggestedFixes);
}
@Override
public final Builder suggestedFixes(Collection suggestedFixes) {
this.suggestedFixes = SuggestedFixesCopier.copy(suggestedFixes);
return this;
}
@Override
@SafeVarargs
public final Builder suggestedFixes(SuggestedFix... suggestedFixes) {
suggestedFixes(Arrays.asList(suggestedFixes));
return this;
}
@Override
@SafeVarargs
public final Builder suggestedFixes(Consumer... suggestedFixes) {
suggestedFixes(Stream.of(suggestedFixes).map(c -> SuggestedFix.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public Remediation build() {
return new Remediation(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}