software.amazon.awssdk.services.shield.model.SubResourceSummary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shield Show documentation
Show all versions of shield Show documentation
The AWS Java SDK for AWS Shield module holds the client classes that are used for communicating with
AWS Shield.
/*
* 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.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;
/**
*
* The attack information for the specified SubResource.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SubResourceSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(SubResourceSummary::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(SubResourceSummary::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField> ATTACK_VECTORS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AttackVectors")
.getter(getter(SubResourceSummary::attackVectors))
.setter(setter(Builder::attackVectors))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttackVectors").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SummarizedAttackVector::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> COUNTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Counters")
.getter(getter(SubResourceSummary::counters))
.setter(setter(Builder::counters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Counters").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(TYPE_FIELD, ID_FIELD,
ATTACK_VECTORS_FIELD, COUNTERS_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final String id;
private final List attackVectors;
private final List counters;
private SubResourceSummary(BuilderImpl builder) {
this.type = builder.type;
this.id = builder.id;
this.attackVectors = builder.attackVectors;
this.counters = builder.counters;
}
/**
*
* The SubResource type.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link SubResourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The SubResource type.
* @see SubResourceType
*/
public final SubResourceType type() {
return SubResourceType.fromValue(type);
}
/**
*
* The SubResource type.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link SubResourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The SubResource type.
* @see SubResourceType
*/
public final String typeAsString() {
return type;
}
/**
*
* The unique identifier (ID) of the SubResource.
*
*
* @return The unique identifier (ID) of the SubResource.
*/
public final String id() {
return id;
}
/**
* For responses, this returns true if the service returned a value for the AttackVectors 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 hasAttackVectors() {
return attackVectors != null && !(attackVectors instanceof SdkAutoConstructList);
}
/**
*
* The list of attack types and associated counters.
*
*
* 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 #hasAttackVectors} method.
*
*
* @return The list of attack types and associated counters.
*/
public final List attackVectors() {
return attackVectors;
}
/**
* For responses, this returns true if the service returned a value for the Counters 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 hasCounters() {
return counters != null && !(counters instanceof SdkAutoConstructList);
}
/**
*
* The 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 #hasCounters} method.
*
*
* @return The counters that describe the details of the attack.
*/
public final List counters() {
return counters;
}
@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(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(hasAttackVectors() ? attackVectors() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasCounters() ? counters() : 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 SubResourceSummary)) {
return false;
}
SubResourceSummary other = (SubResourceSummary) obj;
return Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(id(), other.id())
&& hasAttackVectors() == other.hasAttackVectors() && Objects.equals(attackVectors(), other.attackVectors())
&& hasCounters() == other.hasCounters() && Objects.equals(counters(), other.counters());
}
/**
* 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("SubResourceSummary").add("Type", typeAsString()).add("Id", id())
.add("AttackVectors", hasAttackVectors() ? attackVectors() : null)
.add("Counters", hasCounters() ? counters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "AttackVectors":
return Optional.ofNullable(clazz.cast(attackVectors()));
case "Counters":
return Optional.ofNullable(clazz.cast(counters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SubResourceSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The SubResource type.
*
*
* @param type
* The SubResource type.
* @see SubResourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SubResourceType
*/
Builder type(String type);
/**
*
* The SubResource type.
*
*
* @param type
* The SubResource type.
* @see SubResourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SubResourceType
*/
Builder type(SubResourceType type);
/**
*
* The unique identifier (ID) of the SubResource.
*
*
* @param id
* The unique identifier (ID) of the SubResource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The list of attack types and associated counters.
*
*
* @param attackVectors
* The list of attack types and associated counters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attackVectors(Collection attackVectors);
/**
*
* The list of attack types and associated counters.
*
*
* @param attackVectors
* The list of attack types and associated counters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attackVectors(SummarizedAttackVector... attackVectors);
/**
*
* The list of attack types and associated counters.
*
* This is a convenience method that creates an instance of the {@link List.Builder}
* avoiding the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called
* immediately and its result is passed to {@link #attackVectors(List)}.
*
* @param attackVectors
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #attackVectors(List)
*/
Builder attackVectors(Consumer... attackVectors);
/**
*
* The counters that describe the details of the attack.
*
*
* @param counters
* The counters that describe the details of the attack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder counters(Collection counters);
/**
*
* The counters that describe the details of the attack.
*
*
* @param counters
* The counters that describe the details of the attack.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder counters(SummarizedCounter... counters);
/**
*
* The counters that describe the details of the attack.
*
* This is a convenience method that creates an instance of the {@link List.Builder} avoiding
* the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #counters(List)}.
*
* @param counters
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #counters(List)
*/
Builder counters(Consumer... counters);
}
static final class BuilderImpl implements Builder {
private String type;
private String id;
private List attackVectors = DefaultSdkAutoConstructList.getInstance();
private List counters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(SubResourceSummary model) {
type(model.type);
id(model.id);
attackVectors(model.attackVectors);
counters(model.counters);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(SubResourceType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final List getAttackVectors() {
List result = SummarizedAttackVectorListCopier.copyToBuilder(this.attackVectors);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAttackVectors(Collection attackVectors) {
this.attackVectors = SummarizedAttackVectorListCopier.copyFromBuilder(attackVectors);
}
@Override
public final Builder attackVectors(Collection attackVectors) {
this.attackVectors = SummarizedAttackVectorListCopier.copy(attackVectors);
return this;
}
@Override
@SafeVarargs
public final Builder attackVectors(SummarizedAttackVector... attackVectors) {
attackVectors(Arrays.asList(attackVectors));
return this;
}
@Override
@SafeVarargs
public final Builder attackVectors(Consumer... attackVectors) {
attackVectors(Stream.of(attackVectors).map(c -> SummarizedAttackVector.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getCounters() {
List result = SummarizedCounterListCopier.copyToBuilder(this.counters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCounters(Collection counters) {
this.counters = SummarizedCounterListCopier.copyFromBuilder(counters);
}
@Override
public final Builder counters(Collection counters) {
this.counters = SummarizedCounterListCopier.copy(counters);
return this;
}
@Override
@SafeVarargs
public final Builder counters(SummarizedCounter... counters) {
counters(Arrays.asList(counters));
return this;
}
@Override
@SafeVarargs
public final Builder counters(Consumer... counters) {
counters(Stream.of(counters).map(c -> SummarizedCounter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public SubResourceSummary build() {
return new SubResourceSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy