software.amazon.awssdk.services.wafv2.model.DescribeManagedRuleGroupResponse 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 DescribeManagedRuleGroupResponse extends Wafv2Response implements
ToCopyableBuilder {
private static final SdkField CAPACITY_FIELD = SdkField. builder(MarshallingType.LONG).memberName("Capacity")
.getter(getter(DescribeManagedRuleGroupResponse::capacity)).setter(setter(Builder::capacity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Capacity").build()).build();
private static final SdkField> RULES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Rules")
.getter(getter(DescribeManagedRuleGroupResponse::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(RuleSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CAPACITY_FIELD, RULES_FIELD));
private final Long capacity;
private final List rules;
private DescribeManagedRuleGroupResponse(BuilderImpl builder) {
super(builder);
this.capacity = builder.capacity;
this.rules = builder.rules;
}
/**
*
* The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) 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 each rule's relative cost. Rule group capacity is
* fixed at creation, so users can 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. AWS WAF uses web ACL capacity units (WCU)
* 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 each rule's relative cost.
* Rule group capacity is fixed at creation, so users can 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;
}
/**
* 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);
}
/**
*
*
* 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
*/
public List rules() {
return rules;
}
@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(capacity());
hashCode = 31 * hashCode + Objects.hashCode(rules());
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 DescribeManagedRuleGroupResponse)) {
return false;
}
DescribeManagedRuleGroupResponse other = (DescribeManagedRuleGroupResponse) obj;
return Objects.equals(capacity(), other.capacity()) && Objects.equals(rules(), other.rules());
}
/**
* 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("DescribeManagedRuleGroupResponse").add("Capacity", capacity()).add("Rules", rules()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Capacity":
return Optional.ofNullable(clazz.cast(capacity()));
case "Rules":
return Optional.ofNullable(clazz.cast(rules()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeManagedRuleGroupResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Response.Builder, SdkPojo, CopyableBuilder {
/**
*
* The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) 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 each rule's relative cost. Rule group
* capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU
* limit for web ACLs is 1,500.
*
*
* @param capacity
* The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units
* (WCU) 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 each rule's
* relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage
* when they use a rule group. The WCU limit for web ACLs is 1,500.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capacity(Long capacity);
/**
*
*
* @param rules
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(Collection rules);
/**
*
*
* @param rules
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rules(RuleSummary... rules);
/**
*
* 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 #rules(List)}.
*
* @param rules
* 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 #rules(List)
*/
Builder rules(Consumer... rules);
}
static final class BuilderImpl extends Wafv2Response.BuilderImpl implements Builder {
private Long capacity;
private List rules = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeManagedRuleGroupResponse model) {
super(model);
capacity(model.capacity);
rules(model.rules);
}
public final Long getCapacity() {
return capacity;
}
@Override
public final Builder capacity(Long capacity) {
this.capacity = capacity;
return this;
}
public final void setCapacity(Long capacity) {
this.capacity = capacity;
}
public final Collection getRules() {
return rules != null ? rules.stream().map(RuleSummary::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder rules(Collection rules) {
this.rules = RuleSummariesCopier.copy(rules);
return this;
}
@Override
@SafeVarargs
public final Builder rules(RuleSummary... rules) {
rules(Arrays.asList(rules));
return this;
}
@Override
@SafeVarargs
public final Builder rules(Consumer... rules) {
rules(Stream.of(rules).map(c -> RuleSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setRules(Collection rules) {
this.rules = RuleSummariesCopier.copyFromBuilder(rules);
}
@Override
public DescribeManagedRuleGroupResponse build() {
return new DescribeManagedRuleGroupResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy