
software.amazon.awssdk.services.wafv2.model.CreateRuleGroupRequest 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 CreateRuleGroupRequest extends Wafv2Request implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(CreateRuleGroupRequest::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(CreateRuleGroupRequest::scopeAsString)).setter(setter(Builder::scope))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Scope").build()).build();
private static final SdkField CAPACITY_FIELD = SdkField. builder(MarshallingType.LONG).memberName("Capacity")
.getter(getter(CreateRuleGroupRequest::capacity)).setter(setter(Builder::capacity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Capacity").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateRuleGroupRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rules")
.getter(getter(CreateRuleGroupRequest::rules))
.setter(setter(Builder::rules))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Rules").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Rule::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField VISIBILITY_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("VisibilityConfig")
.getter(getter(CreateRuleGroupRequest::visibilityConfig)).setter(setter(Builder::visibilityConfig))
.constructor(VisibilityConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VisibilityConfig").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateRuleGroupRequest::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,
CAPACITY_FIELD, DESCRIPTION_FIELD, RULES_FIELD, VISIBILITY_CONFIG_FIELD, TAGS_FIELD));
private final String name;
private final String scope;
private final Long capacity;
private final String description;
private final List rules;
private final VisibilityConfig visibilityConfig;
private final List tags;
private CreateRuleGroupRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.scope = builder.scope;
this.capacity = builder.capacity;
this.description = builder.description;
this.rules = builder.rules;
this.visibilityConfig = builder.visibilityConfig;
this.tags = builder.tags;
}
/**
*
* The name of the rule group. You cannot change the name of a rule group after you create it.
*
*
* @return The name of the rule group. You cannot change the name of a rule group after you create it.
*/
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;
}
/**
*
* The web ACL capacity units (WCUs) required for this rule group.
*
*
* When you create your own rule group, you define this, and you cannot change it after creation. When you add or
* modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules
* using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups,
* and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each
* rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power.
* Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule
* group. The WCU limit for web ACLs is 1,500.
*
*
* @return The web ACL capacity units (WCUs) required for this rule group.
*
* When you create your own rule group, you define this, and you cannot change it after creation. When you
* add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a
* set of rules using CheckCapacity.
*
*
* AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative
* cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use
* more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU
* usage when they use a rule group. The WCU limit for web ACLs is 1,500.
*/
public Long capacity() {
return capacity;
}
/**
*
* A description of the rule group that helps with identification. You cannot change the description of a rule group
* after you create it.
*
*
* @return A description of the rule group that helps with identification. You cannot change the description of a
* rule group after you create it.
*/
public String description() {
return description;
}
/**
* Returns true if the Rules 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 hasRules() {
return rules != null && !(rules instanceof SdkAutoConstructList);
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasRules()} to see if a value was sent in this field.
*
*
* @return The Rule statements used to identify the web requests that you want to allow, block, or count.
* Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and
* parameters that govern how AWS WAF handles them.
*/
public List rules() {
return rules;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @return Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public VisibilityConfig visibilityConfig() {
return visibilityConfig;
}
/**
* 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 extends Builder> 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(capacity());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(rules());
hashCode = 31 * hashCode + Objects.hashCode(visibilityConfig());
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 CreateRuleGroupRequest)) {
return false;
}
CreateRuleGroupRequest other = (CreateRuleGroupRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(scopeAsString(), other.scopeAsString())
&& Objects.equals(capacity(), other.capacity()) && Objects.equals(description(), other.description())
&& Objects.equals(rules(), other.rules()) && Objects.equals(visibilityConfig(), other.visibilityConfig())
&& 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("CreateRuleGroupRequest").add("Name", name()).add("Scope", scopeAsString())
.add("Capacity", capacity()).add("Description", description()).add("Rules", rules())
.add("VisibilityConfig", visibilityConfig()).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 "Capacity":
return Optional.ofNullable(clazz.cast(capacity()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Rules":
return Optional.ofNullable(clazz.cast(rules()));
case "VisibilityConfig":
return Optional.ofNullable(clazz.cast(visibilityConfig()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function