software.amazon.awssdk.services.fms.model.AwsVPCSecurityGroupViolation 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;
/**
*
* Violation detail for the rule violation in a security group when compared to the primary security group of the
* Firewall Manager policy.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AwsVPCSecurityGroupViolation implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VIOLATION_TARGET_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ViolationTarget").getter(getter(AwsVPCSecurityGroupViolation::violationTarget))
.setter(setter(Builder::violationTarget))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ViolationTarget").build()).build();
private static final SdkField VIOLATION_TARGET_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ViolationTargetDescription")
.getter(getter(AwsVPCSecurityGroupViolation::violationTargetDescription))
.setter(setter(Builder::violationTargetDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ViolationTargetDescription").build())
.build();
private static final SdkField> PARTIAL_MATCHES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PartialMatches")
.getter(getter(AwsVPCSecurityGroupViolation::partialMatches))
.setter(setter(Builder::partialMatches))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PartialMatches").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PartialMatch::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> POSSIBLE_SECURITY_GROUP_REMEDIATION_ACTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("PossibleSecurityGroupRemediationActions")
.getter(getter(AwsVPCSecurityGroupViolation::possibleSecurityGroupRemediationActions))
.setter(setter(Builder::possibleSecurityGroupRemediationActions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("PossibleSecurityGroupRemediationActions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SecurityGroupRemediationAction::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VIOLATION_TARGET_FIELD,
VIOLATION_TARGET_DESCRIPTION_FIELD, PARTIAL_MATCHES_FIELD, POSSIBLE_SECURITY_GROUP_REMEDIATION_ACTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String violationTarget;
private final String violationTargetDescription;
private final List partialMatches;
private final List possibleSecurityGroupRemediationActions;
private AwsVPCSecurityGroupViolation(BuilderImpl builder) {
this.violationTarget = builder.violationTarget;
this.violationTargetDescription = builder.violationTargetDescription;
this.partialMatches = builder.partialMatches;
this.possibleSecurityGroupRemediationActions = builder.possibleSecurityGroupRemediationActions;
}
/**
*
* The security group rule that is being evaluated.
*
*
* @return The security group rule that is being evaluated.
*/
public final String violationTarget() {
return violationTarget;
}
/**
*
* A description of the security group that violates the policy.
*
*
* @return A description of the security group that violates the policy.
*/
public final String violationTargetDescription() {
return violationTargetDescription;
}
/**
* For responses, this returns true if the service returned a value for the PartialMatches 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 hasPartialMatches() {
return partialMatches != null && !(partialMatches instanceof SdkAutoConstructList);
}
/**
*
* List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
*
*
* 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 #hasPartialMatches} method.
*
*
* @return List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
*/
public final List partialMatches() {
return partialMatches;
}
/**
* For responses, this returns true if the service returned a value for the PossibleSecurityGroupRemediationActions
* 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 hasPossibleSecurityGroupRemediationActions() {
return possibleSecurityGroupRemediationActions != null
&& !(possibleSecurityGroupRemediationActions instanceof SdkAutoConstructList);
}
/**
*
* Remediation options for the rule specified in the ViolationTarget.
*
*
* 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 #hasPossibleSecurityGroupRemediationActions} method.
*
*
* @return Remediation options for the rule specified in the ViolationTarget.
*/
public final List possibleSecurityGroupRemediationActions() {
return possibleSecurityGroupRemediationActions;
}
@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(violationTarget());
hashCode = 31 * hashCode + Objects.hashCode(violationTargetDescription());
hashCode = 31 * hashCode + Objects.hashCode(hasPartialMatches() ? partialMatches() : null);
hashCode = 31
* hashCode
+ Objects.hashCode(hasPossibleSecurityGroupRemediationActions() ? possibleSecurityGroupRemediationActions()
: 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 AwsVPCSecurityGroupViolation)) {
return false;
}
AwsVPCSecurityGroupViolation other = (AwsVPCSecurityGroupViolation) obj;
return Objects.equals(violationTarget(), other.violationTarget())
&& Objects.equals(violationTargetDescription(), other.violationTargetDescription())
&& hasPartialMatches() == other.hasPartialMatches() && Objects.equals(partialMatches(), other.partialMatches())
&& hasPossibleSecurityGroupRemediationActions() == other.hasPossibleSecurityGroupRemediationActions()
&& Objects.equals(possibleSecurityGroupRemediationActions(), other.possibleSecurityGroupRemediationActions());
}
/**
* 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("AwsVPCSecurityGroupViolation")
.add("ViolationTarget", violationTarget())
.add("ViolationTargetDescription", violationTargetDescription())
.add("PartialMatches", hasPartialMatches() ? partialMatches() : null)
.add("PossibleSecurityGroupRemediationActions",
hasPossibleSecurityGroupRemediationActions() ? possibleSecurityGroupRemediationActions() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ViolationTarget":
return Optional.ofNullable(clazz.cast(violationTarget()));
case "ViolationTargetDescription":
return Optional.ofNullable(clazz.cast(violationTargetDescription()));
case "PartialMatches":
return Optional.ofNullable(clazz.cast(partialMatches()));
case "PossibleSecurityGroupRemediationActions":
return Optional.ofNullable(clazz.cast(possibleSecurityGroupRemediationActions()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AwsVPCSecurityGroupViolation) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The security group rule that is being evaluated.
*
*
* @param violationTarget
* The security group rule that is being evaluated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder violationTarget(String violationTarget);
/**
*
* A description of the security group that violates the policy.
*
*
* @param violationTargetDescription
* A description of the security group that violates the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder violationTargetDescription(String violationTargetDescription);
/**
*
* List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
*
*
* @param partialMatches
* List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partialMatches(Collection partialMatches);
/**
*
* List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
*
*
* @param partialMatches
* List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder partialMatches(PartialMatch... partialMatches);
/**
*
* List of rules specified in the security group of the Firewall Manager policy that partially match the
* ViolationTarget rule.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fms.model.PartialMatch.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.fms.model.PartialMatch#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.fms.model.PartialMatch.Builder#build()} is called immediately and its
* result is passed to {@link #partialMatches(List)}.
*
* @param partialMatches
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.fms.model.PartialMatch.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #partialMatches(java.util.Collection)
*/
Builder partialMatches(Consumer... partialMatches);
/**
*
* Remediation options for the rule specified in the ViolationTarget.
*
*
* @param possibleSecurityGroupRemediationActions
* Remediation options for the rule specified in the ViolationTarget.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder possibleSecurityGroupRemediationActions(
Collection possibleSecurityGroupRemediationActions);
/**
*
* Remediation options for the rule specified in the ViolationTarget.
*
*
* @param possibleSecurityGroupRemediationActions
* Remediation options for the rule specified in the ViolationTarget.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder possibleSecurityGroupRemediationActions(SecurityGroupRemediationAction... possibleSecurityGroupRemediationActions);
/**
*
* Remediation options for the rule specified in the ViolationTarget.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.fms.model.SecurityGroupRemediationAction.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.fms.model.SecurityGroupRemediationAction#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.fms.model.SecurityGroupRemediationAction.Builder#build()} is called
* immediately and its result is passed to {@link
* #possibleSecurityGroupRemediationActions(List)}.
*
* @param possibleSecurityGroupRemediationActions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.fms.model.SecurityGroupRemediationAction.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #possibleSecurityGroupRemediationActions(java.util.Collection)
*/
Builder possibleSecurityGroupRemediationActions(
Consumer... possibleSecurityGroupRemediationActions);
}
static final class BuilderImpl implements Builder {
private String violationTarget;
private String violationTargetDescription;
private List partialMatches = DefaultSdkAutoConstructList.getInstance();
private List possibleSecurityGroupRemediationActions = DefaultSdkAutoConstructList
.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AwsVPCSecurityGroupViolation model) {
violationTarget(model.violationTarget);
violationTargetDescription(model.violationTargetDescription);
partialMatches(model.partialMatches);
possibleSecurityGroupRemediationActions(model.possibleSecurityGroupRemediationActions);
}
public final String getViolationTarget() {
return violationTarget;
}
public final void setViolationTarget(String violationTarget) {
this.violationTarget = violationTarget;
}
@Override
public final Builder violationTarget(String violationTarget) {
this.violationTarget = violationTarget;
return this;
}
public final String getViolationTargetDescription() {
return violationTargetDescription;
}
public final void setViolationTargetDescription(String violationTargetDescription) {
this.violationTargetDescription = violationTargetDescription;
}
@Override
public final Builder violationTargetDescription(String violationTargetDescription) {
this.violationTargetDescription = violationTargetDescription;
return this;
}
public final List getPartialMatches() {
List result = PartialMatchesCopier.copyToBuilder(this.partialMatches);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPartialMatches(Collection partialMatches) {
this.partialMatches = PartialMatchesCopier.copyFromBuilder(partialMatches);
}
@Override
public final Builder partialMatches(Collection partialMatches) {
this.partialMatches = PartialMatchesCopier.copy(partialMatches);
return this;
}
@Override
@SafeVarargs
public final Builder partialMatches(PartialMatch... partialMatches) {
partialMatches(Arrays.asList(partialMatches));
return this;
}
@Override
@SafeVarargs
public final Builder partialMatches(Consumer... partialMatches) {
partialMatches(Stream.of(partialMatches).map(c -> PartialMatch.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getPossibleSecurityGroupRemediationActions() {
List result = SecurityGroupRemediationActionsCopier
.copyToBuilder(this.possibleSecurityGroupRemediationActions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setPossibleSecurityGroupRemediationActions(
Collection possibleSecurityGroupRemediationActions) {
this.possibleSecurityGroupRemediationActions = SecurityGroupRemediationActionsCopier
.copyFromBuilder(possibleSecurityGroupRemediationActions);
}
@Override
public final Builder possibleSecurityGroupRemediationActions(
Collection possibleSecurityGroupRemediationActions) {
this.possibleSecurityGroupRemediationActions = SecurityGroupRemediationActionsCopier
.copy(possibleSecurityGroupRemediationActions);
return this;
}
@Override
@SafeVarargs
public final Builder possibleSecurityGroupRemediationActions(
SecurityGroupRemediationAction... possibleSecurityGroupRemediationActions) {
possibleSecurityGroupRemediationActions(Arrays.asList(possibleSecurityGroupRemediationActions));
return this;
}
@Override
@SafeVarargs
public final Builder possibleSecurityGroupRemediationActions(
Consumer... possibleSecurityGroupRemediationActions) {
possibleSecurityGroupRemediationActions(Stream.of(possibleSecurityGroupRemediationActions)
.map(c -> SecurityGroupRemediationAction.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public AwsVPCSecurityGroupViolation build() {
return new AwsVPCSecurityGroupViolation(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}