software.amazon.awssdk.services.shield.model.SummarizedAttackVector Maven / Gradle / Ivy
Show all versions of shield 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.shield.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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 summary of information about the attack.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SummarizedAttackVector implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VECTOR_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VectorType").getter(getter(SummarizedAttackVector::vectorType)).setter(setter(Builder::vectorType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VectorType").build()).build();
private static final SdkField> VECTOR_COUNTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("VectorCounters")
.getter(getter(SummarizedAttackVector::vectorCounters))
.setter(setter(Builder::vectorCounters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VectorCounters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SummarizedCounter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VECTOR_TYPE_FIELD,
VECTOR_COUNTERS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String vectorType;
private final List vectorCounters;
private SummarizedAttackVector(BuilderImpl builder) {
this.vectorType = builder.vectorType;
this.vectorCounters = builder.vectorCounters;
}
/**
*
* The attack type, for example, SNMP reflection or SYN flood.
*
*
* @return The attack type, for example, SNMP reflection or SYN flood.
*/
public final String vectorType() {
return vectorType;
}
/**
* For responses, this returns true if the service returned a value for the VectorCounters 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 hasVectorCounters() {
return vectorCounters != null && !(vectorCounters instanceof SdkAutoConstructList);
}
/**
*
* The list of counters that describe the details of the attack.
*
*
* 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 #hasVectorCounters} method.
*
*
* @return The list of counters that describe the details of the attack.
*/
public final List vectorCounters() {
return vectorCounters;
}
@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(vectorType());
hashCode = 31 * hashCode + Objects.hashCode(hasVectorCounters() ? vectorCounters() : 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 SummarizedAttackVector)) {
return false;
}
SummarizedAttackVector other = (SummarizedAttackVector) obj;
return Objects.equals(vectorType(), other.vectorType()) && hasVectorCounters() == other.hasVectorCounters()
&& Objects.equals(vectorCounters(), other.vectorCounters());
}
/**
* 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("SummarizedAttackVector").add("VectorType", vectorType())
.add("VectorCounters", hasVectorCounters() ? vectorCounters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "VectorType":
return Optional.ofNullable(clazz.cast(vectorType()));
case "VectorCounters":
return Optional.ofNullable(clazz.cast(vectorCounters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("VectorType", VECTOR_TYPE_FIELD);
map.put("VectorCounters", VECTOR_COUNTERS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((SummarizedAttackVector) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The attack type, for example, SNMP reflection or SYN flood.
*
*
* @param vectorType
* The attack type, for example, SNMP reflection or SYN flood.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vectorType(String vectorType);
/**
*
* The list of counters that describe the details of the attack.
*
*
* @param vectorCounters
* The list of counters that describe the details of the attack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vectorCounters(Collection vectorCounters);
/**
*
* The list of counters that describe the details of the attack.
*
*
* @param vectorCounters
* The list of counters that describe the details of the attack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vectorCounters(SummarizedCounter... vectorCounters);
/**
*
* The list of counters that describe the details of the attack.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.shield.model.SummarizedCounter.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.shield.model.SummarizedCounter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.shield.model.SummarizedCounter.Builder#build()} is called immediately
* and its result is passed to {@link #vectorCounters(List)}.
*
* @param vectorCounters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.shield.model.SummarizedCounter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #vectorCounters(java.util.Collection)
*/
Builder vectorCounters(Consumer... vectorCounters);
}
static final class BuilderImpl implements Builder {
private String vectorType;
private List vectorCounters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SummarizedAttackVector model) {
vectorType(model.vectorType);
vectorCounters(model.vectorCounters);
}
public final String getVectorType() {
return vectorType;
}
public final void setVectorType(String vectorType) {
this.vectorType = vectorType;
}
@Override
public final Builder vectorType(String vectorType) {
this.vectorType = vectorType;
return this;
}
public final List getVectorCounters() {
List result = SummarizedCounterListCopier.copyToBuilder(this.vectorCounters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setVectorCounters(Collection vectorCounters) {
this.vectorCounters = SummarizedCounterListCopier.copyFromBuilder(vectorCounters);
}
@Override
public final Builder vectorCounters(Collection vectorCounters) {
this.vectorCounters = SummarizedCounterListCopier.copy(vectorCounters);
return this;
}
@Override
@SafeVarargs
public final Builder vectorCounters(SummarizedCounter... vectorCounters) {
vectorCounters(Arrays.asList(vectorCounters));
return this;
}
@Override
@SafeVarargs
public final Builder vectorCounters(Consumer... vectorCounters) {
vectorCounters(Stream.of(vectorCounters).map(c -> SummarizedCounter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public SummarizedAttackVector build() {
return new SummarizedAttackVector(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}