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.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListProtectionsResponse extends ShieldResponse implements
ToCopyableBuilder {
private static final SdkField> PROTECTIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Protections")
.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)
.memberName("NextToken").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 static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final List protections;
private final String nextToken;
private ListProtectionsResponse(BuilderImpl builder) {
super(builder);
this.protections = builder.protections;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Protections 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 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.
*
*
* 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 #hasProtections} method.
*
*
* @return The array of enabled Protection objects.
*/
public final List protections() {
return protections;
}
/**
*
* When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
* available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
* next batch of objects by requesting the list again and providing the token that was returned by the prior call in
* your request.
*
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
* MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
* may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
* NextToken value.
*
*
* @return When you request a list of objects from Shield Advanced, if the response does not include all of the
* remaining available objects, Shield Advanced includes a NextToken value in the response. You
* can retrieve the next batch of objects by requesting the list again and providing the token that was
* returned by the prior call in your request.
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single call
* with the MaxResults setting. Shield Advanced will not return more than
* MaxResults objects, but may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include
* a NextToken value.
*/
public final 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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasProtections() ? protections() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final 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 hasProtections() == other.hasProtections() && 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 final String toString() {
return ToString.builder("ListProtectionsResponse").add("Protections", hasProtections() ? protections() : null)
.add("NextToken", nextToken()).build();
}
public final 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 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("Protections", PROTECTIONS_FIELD);
map.put("NextToken", NEXT_TOKEN_FIELD);
return Collections.unmodifiableMap(map);
}
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 method that creates an instance of the
* {@link software.amazon.awssdk.services.shield.model.Protection.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.shield.model.Protection#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.shield.model.Protection.Builder#build()} is called immediately and its
* result is passed to {@link #protections(List)}.
*
* @param protections
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.shield.model.Protection.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #protections(java.util.Collection)
*/
Builder protections(Consumer... protections);
/**
*
* When you request a list of objects from Shield Advanced, if the response does not include all of the
* remaining available objects, Shield Advanced includes a NextToken value in the response. You can
* retrieve the next batch of objects by requesting the list again and providing the token that was returned by
* the prior call in your request.
*
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with
* the MaxResults setting. Shield Advanced will not return more than MaxResults
* objects, but may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
* NextToken value.
*
*
* @param nextToken
* When you request a list of objects from Shield Advanced, if the response does not include all of the
* remaining available objects, Shield Advanced includes a NextToken value in the response.
* You can retrieve the next batch of objects by requesting the list again and providing the token that
* was returned by the prior call in your request.
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single
* call with the MaxResults setting. Shield Advanced will not return more than
* MaxResults objects, but may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will
* include a NextToken value.
* @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 List getProtections() {
List result = ProtectionsCopier.copyToBuilder(this.protections);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setProtections(Collection protections) {
this.protections = ProtectionsCopier.copyFromBuilder(protections);
}
@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 String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public ListProtectionsResponse build() {
return new ListProtectionsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}