software.amazon.awssdk.services.wafv2.model.ListIpSetsRequest 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.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 ListIpSetsRequest extends Wafv2Request implements
ToCopyableBuilder {
private static final SdkField SCOPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Scope")
.getter(getter(ListIpSetsRequest::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField NEXT_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextMarker").getter(getter(ListIpSetsRequest::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(ListIpSetsRequest::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(SCOPE_FIELD,
NEXT_MARKER_FIELD, LIMIT_FIELD));
private final String scope;
private final String nextMarker;
private final Integer limit;
private ListIpSetsRequest(BuilderImpl builder) {
super(builder);
this.scope = builder.scope;
this.nextMarker = builder.nextMarker;
this.limit = builder.limit;
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link Scope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @see Scope
*/
public Scope scope() {
return Scope.fromValue(scope);
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #scope} will return
* {@link Scope#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #scopeAsString}.
*
*
* @return Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @see Scope
*/
public String scopeAsString() {
return scope;
}
/**
*
* 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, AWS 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, AWS 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 String nextMarker() {
return nextMarker;
}
/**
*
* The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in
* the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the
* next batch of objects.
*
*
* @return The maximum number of objects that you want AWS WAF to return for this request. If more objects are
* available, in the response, AWS WAF provides a NextMarker value that you can use in a
* subsequent call to get the next batch of objects.
*/
public 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(scopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextMarker());
hashCode = 31 * hashCode + Objects.hashCode(limit());
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 ListIpSetsRequest)) {
return false;
}
ListIpSetsRequest other = (ListIpSetsRequest) obj;
return Objects.equals(scopeAsString(), other.scopeAsString()) && 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 String toString() {
return ToString.builder("ListIpSetsRequest").add("Scope", scopeAsString()).add("NextMarker", nextMarker())
.add("Limit", limit()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Scope":
return Optional.ofNullable(clazz.cast(scopeAsString()));
case "NextMarker":
return Optional.ofNullable(clazz.cast(nextMarker()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListIpSetsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* @param scope
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @see Scope
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
Builder scope(String scope);
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* @param scope
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL
* API.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the Region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @see Scope
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
Builder scope(Scope scope);
/**
*
* 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, AWS 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, AWS 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);
/**
*
* The maximum number of objects that you want AWS WAF to return for this request. If more objects are
* available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent
* call to get the next batch of objects.
*
*
* @param limit
* The maximum number of objects that you want AWS WAF to return for this request. If more objects are
* available, in the response, AWS WAF provides a NextMarker value that you can use in a
* subsequent call to get the next batch of objects.
* @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 Wafv2Request.BuilderImpl implements Builder {
private String scope;
private String nextMarker;
private Integer limit;
private BuilderImpl() {
}
private BuilderImpl(ListIpSetsRequest model) {
super(model);
scope(model.scope);
nextMarker(model.nextMarker);
limit(model.limit);
}
public final String getScope() {
return scope;
}
@Override
public final Builder scope(String scope) {
this.scope = scope;
return this;
}
@Override
public final Builder scope(Scope scope) {
this.scope(scope == null ? null : scope.toString());
return this;
}
public final void setScope(String scope) {
this.scope = scope;
}
public final String getNextMarker() {
return nextMarker;
}
@Override
public final Builder nextMarker(String nextMarker) {
this.nextMarker = nextMarker;
return this;
}
public final void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
public final Integer getLimit() {
return limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListIpSetsRequest build() {
return new ListIpSetsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}