software.amazon.awssdk.services.waf.model.ListRateBasedRulesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of waf Show documentation
Show all versions of waf Show documentation
The AWS Java SDK for AWS WAF Service module holds the client classes that are used for communicating
with AWS WAF Service
/*
* 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.waf.model;
import java.util.Arrays;
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 software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.LocationTrait;
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 ListRateBasedRulesRequest extends WafRequest implements
ToCopyableBuilder {
private static final SdkField NEXT_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextMarker").getter(getter(ListRateBasedRulesRequest::nextMarker)).setter(setter(Builder::nextMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextMarker").build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(ListRateBasedRulesRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Limit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(NEXT_MARKER_FIELD, LIMIT_FIELD));
private final String nextMarker;
private final Integer limit;
private ListRateBasedRulesRequest(BuilderImpl builder) {
super(builder);
this.nextMarker = builder.nextMarker;
this.limit = builder.limit;
}
/**
*
* If you specify a value for Limit and you have more Rules than the value of
* Limit, AWS WAF returns a NextMarker value in the response that allows you to list
* another group of Rules. For the second and subsequent ListRateBasedRules requests,
* specify the value of NextMarker from the previous response to get information about another batch of
* Rules.
*
*
* @return If you specify a value for Limit and you have more Rules than the value of
* Limit, AWS WAF returns a NextMarker value in the response that allows you to
* list another group of Rules. For the second and subsequent ListRateBasedRules
* requests, specify the value of NextMarker from the previous response to get information
* about another batch of Rules.
*/
public final String nextMarker() {
return nextMarker;
}
/**
*
* Specifies the number of Rules that you want AWS WAF to return for this request. If you have more
* Rules than the number that you specify for Limit, the response includes a
* NextMarker value that you can use to get another batch of Rules.
*
*
* @return Specifies the number of Rules that you want AWS WAF to return for this request. If you have
* more Rules than the number that you specify for Limit, the response includes a
* NextMarker value that you can use to get another batch of Rules.
*/
public final Integer limit() {
return limit;
}
@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(limit());
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 ListRateBasedRulesRequest)) {
return false;
}
ListRateBasedRulesRequest other = (ListRateBasedRulesRequest) obj;
return Objects.equals(nextMarker(), other.nextMarker()) && Objects.equals(limit(), other.limit());
}
/**
* 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("ListRateBasedRulesRequest").add("NextMarker", nextMarker()).add("Limit", limit()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextMarker":
return Optional.ofNullable(clazz.cast(nextMarker()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListRateBasedRulesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WafRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* If you specify a value for Limit and you have more Rules than the value of
* Limit, AWS WAF returns a NextMarker value in the response that allows you to list
* another group of Rules. For the second and subsequent ListRateBasedRules requests,
* specify the value of NextMarker from the previous response to get information about another
* batch of Rules.
*
*
* @param nextMarker
* If you specify a value for Limit and you have more Rules than the value of
* Limit, AWS WAF returns a NextMarker value in the response that allows you to
* list another group of Rules. For the second and subsequent
* ListRateBasedRules requests, specify the value of NextMarker from the
* previous response to get information about another batch of Rules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextMarker(String nextMarker);
/**
*
* Specifies the number of Rules that you want AWS WAF to return for this request. If you have more
* Rules than the number that you specify for Limit, the response includes a
* NextMarker value that you can use to get another batch of Rules.
*
*
* @param limit
* Specifies the number of Rules that you want AWS WAF to return for this request. If you
* have more Rules than the number that you specify for Limit, the response
* includes a NextMarker value that you can use to get another batch of Rules.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WafRequest.BuilderImpl implements Builder {
private String nextMarker;
private Integer limit;
private BuilderImpl() {
}
private BuilderImpl(ListRateBasedRulesRequest model) {
super(model);
nextMarker(model.nextMarker);
limit(model.limit);
}
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 Integer getLimit() {
return limit;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListRateBasedRulesRequest build() {
return new ListRateBasedRulesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}