software.amazon.awssdk.services.waf.model.UpdateRuleGroupRequest Maven / Gradle / Ivy
Show all versions of waf Show documentation
/*
* 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.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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 UpdateRuleGroupRequest extends WafRequest implements
ToCopyableBuilder {
private static final SdkField RULE_GROUP_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RuleGroupId").getter(getter(UpdateRuleGroupRequest::ruleGroupId)).setter(setter(Builder::ruleGroupId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleGroupId").build()).build();
private static final SdkField> UPDATES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Updates")
.getter(getter(UpdateRuleGroupRequest::updates))
.setter(setter(Builder::updates))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Updates").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(RuleGroupUpdate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CHANGE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChangeToken").getter(getter(UpdateRuleGroupRequest::changeToken)).setter(setter(Builder::changeToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChangeToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_GROUP_ID_FIELD,
UPDATES_FIELD, CHANGE_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String ruleGroupId;
private final List updates;
private final String changeToken;
private UpdateRuleGroupRequest(BuilderImpl builder) {
super(builder);
this.ruleGroupId = builder.ruleGroupId;
this.updates = builder.updates;
this.changeToken = builder.changeToken;
}
/**
*
* The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is
* returned by CreateRuleGroup and by ListRuleGroups.
*
*
* @return The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is
* returned by CreateRuleGroup and by ListRuleGroups.
*/
public final String ruleGroupId() {
return ruleGroupId;
}
/**
* For responses, this returns true if the service returned a value for the Updates property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasUpdates() {
return updates != null && !(updates instanceof SdkAutoConstructList);
}
/**
*
* An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.
*
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
* WebACL. In this case you do not use ActivatedRule|Action. For all other update
* requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasUpdates} method.
*
*
* @return An array of RuleGroupUpdate objects that you want to insert into or delete from a
* RuleGroup.
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup
* to a WebACL. In this case you do not use ActivatedRule|Action. For all other
* update requests, ActivatedRule|Action is used instead of
* ActivatedRule|OverrideAction.
*/
public final List updates() {
return updates;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @return The value returned by the most recent call to GetChangeToken.
*/
public final String changeToken() {
return changeToken;
}
@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(ruleGroupId());
hashCode = 31 * hashCode + Objects.hashCode(hasUpdates() ? updates() : null);
hashCode = 31 * hashCode + Objects.hashCode(changeToken());
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 UpdateRuleGroupRequest)) {
return false;
}
UpdateRuleGroupRequest other = (UpdateRuleGroupRequest) obj;
return Objects.equals(ruleGroupId(), other.ruleGroupId()) && hasUpdates() == other.hasUpdates()
&& Objects.equals(updates(), other.updates()) && Objects.equals(changeToken(), other.changeToken());
}
/**
* 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("UpdateRuleGroupRequest").add("RuleGroupId", ruleGroupId())
.add("Updates", hasUpdates() ? updates() : null).add("ChangeToken", changeToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RuleGroupId":
return Optional.ofNullable(clazz.cast(ruleGroupId()));
case "Updates":
return Optional.ofNullable(clazz.cast(updates()));
case "ChangeToken":
return Optional.ofNullable(clazz.cast(changeToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("RuleGroupId", RULE_GROUP_ID_FIELD);
map.put("Updates", UPDATES_FIELD);
map.put("ChangeToken", CHANGE_TOKEN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateRuleGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WafRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is
* returned by CreateRuleGroup and by ListRuleGroups.
*
*
* @param ruleGroupId
* The RuleGroupId of the RuleGroup that you want to update. RuleGroupId
* is returned by CreateRuleGroup and by ListRuleGroups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleGroupId(String ruleGroupId);
/**
*
* An array of RuleGroupUpdate objects that you want to insert into or delete from a
* RuleGroup.
*
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
* WebACL. In this case you do not use ActivatedRule|Action. For all other update
* requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*
*
* @param updates
* An array of RuleGroupUpdate objects that you want to insert into or delete from a
* RuleGroup.
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a
* RuleGroup to a WebACL. In this case you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is
* used instead of ActivatedRule|OverrideAction.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updates(Collection updates);
/**
*
* An array of RuleGroupUpdate objects that you want to insert into or delete from a
* RuleGroup.
*
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
* WebACL. In this case you do not use ActivatedRule|Action. For all other update
* requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*
*
* @param updates
* An array of RuleGroupUpdate objects that you want to insert into or delete from a
* RuleGroup.
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a
* RuleGroup to a WebACL. In this case you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is
* used instead of ActivatedRule|OverrideAction.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder updates(RuleGroupUpdate... updates);
/**
*
* An array of RuleGroupUpdate objects that you want to insert into or delete from a
* RuleGroup.
*
*
* You can only insert REGULAR rules into a rule group.
*
*
* ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
* WebACL. In this case you do not use ActivatedRule|Action. For all other update
* requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.waf.model.RuleGroupUpdate.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.waf.model.RuleGroupUpdate#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.waf.model.RuleGroupUpdate.Builder#build()} is called immediately and
* its result is passed to {@link #updates(List)}.
*
* @param updates
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.waf.model.RuleGroupUpdate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #updates(java.util.Collection)
*/
Builder updates(Consumer... updates);
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @param changeToken
* The value returned by the most recent call to GetChangeToken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder changeToken(String changeToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WafRequest.BuilderImpl implements Builder {
private String ruleGroupId;
private List updates = DefaultSdkAutoConstructList.getInstance();
private String changeToken;
private BuilderImpl() {
}
private BuilderImpl(UpdateRuleGroupRequest model) {
super(model);
ruleGroupId(model.ruleGroupId);
updates(model.updates);
changeToken(model.changeToken);
}
public final String getRuleGroupId() {
return ruleGroupId;
}
public final void setRuleGroupId(String ruleGroupId) {
this.ruleGroupId = ruleGroupId;
}
@Override
public final Builder ruleGroupId(String ruleGroupId) {
this.ruleGroupId = ruleGroupId;
return this;
}
public final List getUpdates() {
List result = RuleGroupUpdatesCopier.copyToBuilder(this.updates);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setUpdates(Collection updates) {
this.updates = RuleGroupUpdatesCopier.copyFromBuilder(updates);
}
@Override
public final Builder updates(Collection updates) {
this.updates = RuleGroupUpdatesCopier.copy(updates);
return this;
}
@Override
@SafeVarargs
public final Builder updates(RuleGroupUpdate... updates) {
updates(Arrays.asList(updates));
return this;
}
@Override
@SafeVarargs
public final Builder updates(Consumer... updates) {
updates(Stream.of(updates).map(c -> RuleGroupUpdate.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getChangeToken() {
return changeToken;
}
public final void setChangeToken(String changeToken) {
this.changeToken = changeToken;
}
@Override
public final Builder changeToken(String changeToken) {
this.changeToken = changeToken;
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 UpdateRuleGroupRequest build() {
return new UpdateRuleGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}