software.amazon.awssdk.services.shield.model.ListProtectionsResponse 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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListProtectionsResponse extends ShieldResponse implements
ToCopyableBuilder {
private static final SdkField> PROTECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(ListProtectionsResponse::protections))
.setter(setter(Builder::protections))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Protections").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Protection::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(ListProtectionsResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PROTECTIONS_FIELD,
NEXT_TOKEN_FIELD));
private final List protections;
private final String nextToken;
private ListProtectionsResponse(BuilderImpl builder) {
super(builder);
this.protections = builder.protections;
this.nextToken = builder.nextToken;
}
/**
* Returns true if the Protections property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasProtections() {
return protections != null && !(protections instanceof SdkAutoConstructList);
}
/**
*
* The array of enabled Protection objects.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasProtections()} to see if a value was sent in this field.
*
*
* @return The array of enabled Protection objects.
*/
public List protections() {
return protections;
}
/**
*
* If you specify a value for MaxResults and you have more Protections than the value of MaxResults,
* AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of
* Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the
* previous response to get information about another batch of Protections.
*
*
* AWS WAF might return the list of Protection objects in batches smaller than the number specified by
* MaxResults. If there are more Protection objects to return, AWS WAF will always also return a
* NextToken.
*
*
* @return If you specify a value for MaxResults and you have more Protections than the value of
* MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another
* group of Protections. For the second and subsequent ListProtections requests, specify the value of
* NextToken from the previous response to get information about another batch of Protections.
*
* AWS WAF might return the list of Protection objects in batches smaller than the number specified
* by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a
* NextToken.
*/
public String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(protections());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListProtectionsResponse)) {
return false;
}
ListProtectionsResponse other = (ListProtectionsResponse) obj;
return Objects.equals(protections(), other.protections()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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 String toString() {
return ToString.builder("ListProtectionsResponse").add("Protections", protections()).add("NextToken", nextToken())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Protections":
return Optional.ofNullable(clazz.cast(protections()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListProtectionsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ShieldResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The array of enabled Protection objects.
*
*
* @param protections
* The array of enabled Protection objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder protections(Collection protections);
/**
*
* The array of enabled Protection objects.
*
*
* @param protections
* The array of enabled Protection objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder protections(Protection... protections);
/**
*
* The array of enabled Protection objects.
*
* This is a convenience 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 #protections(List)}.
*
* @param protections
* 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 #protections(List)
*/
Builder protections(Consumer... protections);
/**
*
* If you specify a value for MaxResults and you have more Protections than the value of
* MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another
* group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken
* from the previous response to get information about another batch of Protections.
*
*
* AWS WAF might return the list of Protection objects in batches smaller than the number specified by
* MaxResults. If there are more Protection objects to return, AWS WAF will always also return a
* NextToken.
*
*
* @param nextToken
* If you specify a value for MaxResults and you have more Protections than the value of
* MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list
* another group of Protections. For the second and subsequent ListProtections requests, specify the
* value of NextToken from the previous response to get information about another batch of
* Protections.
*
* AWS WAF might return the list of Protection objects in batches smaller than the number
* specified by MaxResults. If there are more Protection objects to return, AWS WAF will always
* also return a NextToken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends ShieldResponse.BuilderImpl implements Builder {
private List protections = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListProtectionsResponse model) {
super(model);
protections(model.protections);
nextToken(model.nextToken);
}
public final Collection getProtections() {
return protections != null ? protections.stream().map(Protection::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder protections(Collection protections) {
this.protections = ProtectionsCopier.copy(protections);
return this;
}
@Override
@SafeVarargs
public final Builder protections(Protection... protections) {
protections(Arrays.asList(protections));
return this;
}
@Override
@SafeVarargs
public final Builder protections(Consumer... protections) {
protections(Stream.of(protections).map(c -> Protection.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setProtections(Collection protections) {
this.protections = ProtectionsCopier.copyFromBuilder(protections);
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public ListProtectionsResponse build() {
return new ListProtectionsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}