software.amazon.awssdk.services.wafv2.model.CreateRegexPatternSetRequest 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.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.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 CreateRegexPatternSetRequest extends Wafv2Request implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateRegexPatternSetRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField SCOPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Scope")
.getter(getter(CreateRegexPatternSetRequest::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateRegexPatternSetRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> REGULAR_EXPRESSION_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("RegularExpressionList")
.getter(getter(CreateRegexPatternSetRequest::regularExpressionList))
.setter(setter(Builder::regularExpressionList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RegularExpressionList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Regex::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateRegexPatternSetRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, SCOPE_FIELD,
DESCRIPTION_FIELD, REGULAR_EXPRESSION_LIST_FIELD, TAGS_FIELD));
private final String name;
private final String scope;
private final String description;
private final List regularExpressionList;
private final List tags;
private CreateRegexPatternSetRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.scope = builder.scope;
this.description = builder.description;
this.regularExpressionList = builder.regularExpressionList;
this.tags = builder.tags;
}
/**
*
* The name of the set. You cannot change the name after you create the set.
*
*
* @return The name of the set. You cannot change the name after you create the set.
*/
public String name() {
return name;
}
/**
*
* 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;
}
/**
*
* A description of the set that helps with identification. You cannot change the description of a set after you
* create it.
*
*
* @return A description of the set that helps with identification. You cannot change the description of a set after
* you create it.
*/
public String description() {
return description;
}
/**
* Returns true if the RegularExpressionList 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 hasRegularExpressionList() {
return regularExpressionList != null && !(regularExpressionList instanceof SdkAutoConstructList);
}
/**
*
* Array of regular expression strings.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasRegularExpressionList()} to see if a value was sent in this field.
*
*
* @return Array of regular expression strings.
*/
public List regularExpressionList() {
return regularExpressionList;
}
/**
* Returns true if the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* An array of key:value pairs to associate with the resource.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTags()} to see if a value was sent in this field.
*
*
* @return An array of key:value pairs to associate with the resource.
*/
public List tags() {
return tags;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(scopeAsString());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(regularExpressionList());
hashCode = 31 * hashCode + Objects.hashCode(tags());
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 CreateRegexPatternSetRequest)) {
return false;
}
CreateRegexPatternSetRequest other = (CreateRegexPatternSetRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(scopeAsString(), other.scopeAsString())
&& Objects.equals(description(), other.description())
&& Objects.equals(regularExpressionList(), other.regularExpressionList()) && Objects.equals(tags(), other.tags());
}
/**
* 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("CreateRegexPatternSetRequest").add("Name", name()).add("Scope", scopeAsString())
.add("Description", description()).add("RegularExpressionList", regularExpressionList()).add("Tags", tags())
.build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Scope":
return Optional.ofNullable(clazz.cast(scopeAsString()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "RegularExpressionList":
return Optional.ofNullable(clazz.cast(regularExpressionList()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateRegexPatternSetRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the set. You cannot change the name after you create the set.
*
*
* @param name
* The name of the set. You cannot change the name after you create the set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* 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);
/**
*
* A description of the set that helps with identification. You cannot change the description of a set after you
* create it.
*
*
* @param description
* A description of the set that helps with identification. You cannot change the description of a set
* after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* Array of regular expression strings.
*
*
* @param regularExpressionList
* Array of regular expression strings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder regularExpressionList(Collection regularExpressionList);
/**
*
* Array of regular expression strings.
*
*
* @param regularExpressionList
* Array of regular expression strings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder regularExpressionList(Regex... regularExpressionList);
/**
*
* Array of regular expression strings.
*
* 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 #regularExpressionList(List)}.
*
* @param regularExpressionList
* 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 #regularExpressionList(List)
*/
Builder regularExpressionList(Consumer... regularExpressionList);
/**
*
* An array of key:value pairs to associate with the resource.
*
*
* @param tags
* An array of key:value pairs to associate with the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* An array of key:value pairs to associate with the resource.
*
*
* @param tags
* An array of key:value pairs to associate with the resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* An array of key:value pairs to associate with the resource.
*
* 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 #tags(List)}.
*
* @param tags
* 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 #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Wafv2Request.BuilderImpl implements Builder {
private String name;
private String scope;
private String description;
private List regularExpressionList = DefaultSdkAutoConstructList.getInstance();
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateRegexPatternSetRequest model) {
super(model);
name(model.name);
scope(model.scope);
description(model.description);
regularExpressionList(model.regularExpressionList);
tags(model.tags);
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
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 getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
public final Collection getRegularExpressionList() {
return regularExpressionList != null ? regularExpressionList.stream().map(Regex::toBuilder)
.collect(Collectors.toList()) : null;
}
@Override
public final Builder regularExpressionList(Collection regularExpressionList) {
this.regularExpressionList = RegularExpressionListCopier.copy(regularExpressionList);
return this;
}
@Override
@SafeVarargs
public final Builder regularExpressionList(Regex... regularExpressionList) {
regularExpressionList(Arrays.asList(regularExpressionList));
return this;
}
@Override
@SafeVarargs
public final Builder regularExpressionList(Consumer... regularExpressionList) {
regularExpressionList(Stream.of(regularExpressionList).map(c -> Regex.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setRegularExpressionList(Collection regularExpressionList) {
this.regularExpressionList = RegularExpressionListCopier.copyFromBuilder(regularExpressionList);
}
public final Collection getTags() {
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateRegexPatternSetRequest build() {
return new CreateRegexPatternSetRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}