software.amazon.awssdk.services.wafv2.model.ListManagedRuleSetsResponse Maven / Gradle / Ivy
/*
* 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.wafv2.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 ListManagedRuleSetsResponse extends Wafv2Response implements
ToCopyableBuilder {
private static final SdkField NEXT_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextMarker").getter(getter(ListManagedRuleSetsResponse::nextMarker)).setter(setter(Builder::nextMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextMarker").build()).build();
private static final SdkField> MANAGED_RULE_SETS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ManagedRuleSets")
.getter(getter(ListManagedRuleSetsResponse::managedRuleSets))
.setter(setter(Builder::managedRuleSets))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ManagedRuleSets").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ManagedRuleSetSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_MARKER_FIELD,
MANAGED_RULE_SETS_FIELD));
private final String nextMarker;
private final List managedRuleSets;
private ListManagedRuleSetsResponse(BuilderImpl builder) {
super(builder);
this.nextMarker = builder.nextMarker;
this.managedRuleSets = builder.managedRuleSets;
}
/**
*
* When you request a list of objects with a Limit setting, if the number of objects that are still
* available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
* retrieve the next batch of objects, provide the marker from the prior call in your next request.
*
*
* @return When you request a list of objects with a Limit setting, if the number of objects that are
* still available for retrieval exceeds the limit, WAF returns a NextMarker value in the
* response. To retrieve the next batch of objects, provide the marker from the prior call in your next
* request.
*/
public final String nextMarker() {
return nextMarker;
}
/**
* For responses, this returns true if the service returned a value for the ManagedRuleSets 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 hasManagedRuleSets() {
return managedRuleSets != null && !(managedRuleSets instanceof SdkAutoConstructList);
}
/**
*
* Your managed rule sets. If you specified a Limit in your request, this might not be the full list.
*
*
* 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 #hasManagedRuleSets} method.
*
*
* @return Your managed rule sets. If you specified a Limit in your request, this might not be the full
* list.
*/
public final List managedRuleSets() {
return managedRuleSets;
}
@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(nextMarker());
hashCode = 31 * hashCode + Objects.hashCode(hasManagedRuleSets() ? managedRuleSets() : null);
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 ListManagedRuleSetsResponse)) {
return false;
}
ListManagedRuleSetsResponse other = (ListManagedRuleSetsResponse) obj;
return Objects.equals(nextMarker(), other.nextMarker()) && hasManagedRuleSets() == other.hasManagedRuleSets()
&& Objects.equals(managedRuleSets(), other.managedRuleSets());
}
/**
* 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("ListManagedRuleSetsResponse").add("NextMarker", nextMarker())
.add("ManagedRuleSets", hasManagedRuleSets() ? managedRuleSets() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextMarker":
return Optional.ofNullable(clazz.cast(nextMarker()));
case "ManagedRuleSets":
return Optional.ofNullable(clazz.cast(managedRuleSets()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListManagedRuleSetsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Response.Builder, SdkPojo, CopyableBuilder {
/**
*
* When you request a list of objects with a Limit setting, if the number of objects that are still
* available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
* retrieve the next batch of objects, provide the marker from the prior call in your next request.
*
*
* @param nextMarker
* When you request a list of objects with a Limit setting, if the number of objects that
* are still available for retrieval exceeds the limit, WAF returns a NextMarker value in
* the response. To retrieve the next batch of objects, provide the marker from the prior call in your
* next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextMarker(String nextMarker);
/**
*
* Your managed rule sets. If you specified a Limit in your request, this might not be the full
* list.
*
*
* @param managedRuleSets
* Your managed rule sets. If you specified a Limit in your request, this might not be the
* full list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder managedRuleSets(Collection managedRuleSets);
/**
*
* Your managed rule sets. If you specified a Limit in your request, this might not be the full
* list.
*
*
* @param managedRuleSets
* Your managed rule sets. If you specified a Limit in your request, this might not be the
* full list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder managedRuleSets(ManagedRuleSetSummary... managedRuleSets);
/**
*
* Your managed rule sets. If you specified a Limit in your request, this might not be the full
* list.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.wafv2.model.ManagedRuleSetSummary.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.wafv2.model.ManagedRuleSetSummary#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.wafv2.model.ManagedRuleSetSummary.Builder#build()} is called
* immediately and its result is passed to {@link #managedRuleSets(List)}.
*
* @param managedRuleSets
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.ManagedRuleSetSummary.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #managedRuleSets(java.util.Collection)
*/
Builder managedRuleSets(Consumer... managedRuleSets);
}
static final class BuilderImpl extends Wafv2Response.BuilderImpl implements Builder {
private String nextMarker;
private List managedRuleSets = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListManagedRuleSetsResponse model) {
super(model);
nextMarker(model.nextMarker);
managedRuleSets(model.managedRuleSets);
}
public final String getNextMarker() {
return nextMarker;
}
public final void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
@Override
public final Builder nextMarker(String nextMarker) {
this.nextMarker = nextMarker;
return this;
}
public final List getManagedRuleSets() {
List result = ManagedRuleSetSummariesCopier.copyToBuilder(this.managedRuleSets);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setManagedRuleSets(Collection managedRuleSets) {
this.managedRuleSets = ManagedRuleSetSummariesCopier.copyFromBuilder(managedRuleSets);
}
@Override
public final Builder managedRuleSets(Collection managedRuleSets) {
this.managedRuleSets = ManagedRuleSetSummariesCopier.copy(managedRuleSets);
return this;
}
@Override
@SafeVarargs
public final Builder managedRuleSets(ManagedRuleSetSummary... managedRuleSets) {
managedRuleSets(Arrays.asList(managedRuleSets));
return this;
}
@Override
@SafeVarargs
public final Builder managedRuleSets(Consumer... managedRuleSets) {
managedRuleSets(Stream.of(managedRuleSets).map(c -> ManagedRuleSetSummary.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ListManagedRuleSetsResponse build() {
return new ListManagedRuleSetsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}