software.amazon.awssdk.services.wafv2.model.GetManagedRuleSetResponse 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.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 GetManagedRuleSetResponse extends Wafv2Response implements
ToCopyableBuilder {
private static final SdkField MANAGED_RULE_SET_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ManagedRuleSet")
.getter(getter(GetManagedRuleSetResponse::managedRuleSet)).setter(setter(Builder::managedRuleSet))
.constructor(ManagedRuleSet::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ManagedRuleSet").build()).build();
private static final SdkField LOCK_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LockToken").getter(getter(GetManagedRuleSetResponse::lockToken)).setter(setter(Builder::lockToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LockToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MANAGED_RULE_SET_FIELD,
LOCK_TOKEN_FIELD));
private final ManagedRuleSet managedRuleSet;
private final String lockToken;
private GetManagedRuleSetResponse(BuilderImpl builder) {
super(builder);
this.managedRuleSet = builder.managedRuleSet;
this.lockToken = builder.lockToken;
}
/**
*
* The managed rule set that you requested.
*
*
* @return The managed rule set that you requested.
*/
public final ManagedRuleSet managedRuleSet() {
return managedRuleSet;
}
/**
*
* A token used for optimistic locking. WAF returns a token to your get and list requests,
* to mark the state of the entity at the time of the request. To make changes to the entity associated with the
* token, you provide the token to operations like update and delete. WAF uses the token
* to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
* the update fails with a WAFOptimisticLockException. If this happens, perform another
* get, and use the new token returned by that operation.
*
*
* @return A token used for optimistic locking. WAF returns a token to your get and list
* requests, to mark the state of the entity at the time of the request. To make changes to the entity
* associated with the token, you provide the token to operations like update and
* delete. WAF uses the token to ensure that no changes have been made to the entity since you
* last retrieved it. If a change has been made, the update fails with a
* WAFOptimisticLockException. If this happens, perform another get, and use the
* new token returned by that operation.
*/
public final String lockToken() {
return lockToken;
}
@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(managedRuleSet());
hashCode = 31 * hashCode + Objects.hashCode(lockToken());
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 GetManagedRuleSetResponse)) {
return false;
}
GetManagedRuleSetResponse other = (GetManagedRuleSetResponse) obj;
return Objects.equals(managedRuleSet(), other.managedRuleSet()) && Objects.equals(lockToken(), other.lockToken());
}
/**
* 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("GetManagedRuleSetResponse").add("ManagedRuleSet", managedRuleSet())
.add("LockToken", lockToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ManagedRuleSet":
return Optional.ofNullable(clazz.cast(managedRuleSet()));
case "LockToken":
return Optional.ofNullable(clazz.cast(lockToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetManagedRuleSetResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Response.Builder, SdkPojo, CopyableBuilder {
/**
*
* The managed rule set that you requested.
*
*
* @param managedRuleSet
* The managed rule set that you requested.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder managedRuleSet(ManagedRuleSet managedRuleSet);
/**
*
* The managed rule set that you requested.
*
* This is a convenience method that creates an instance of the {@link ManagedRuleSet.Builder} avoiding the need
* to create one manually via {@link ManagedRuleSet#builder()}.
*
*
* When the {@link Consumer} completes, {@link ManagedRuleSet.Builder#build()} is called immediately and its
* result is passed to {@link #managedRuleSet(ManagedRuleSet)}.
*
* @param managedRuleSet
* a consumer that will call methods on {@link ManagedRuleSet.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #managedRuleSet(ManagedRuleSet)
*/
default Builder managedRuleSet(Consumer managedRuleSet) {
return managedRuleSet(ManagedRuleSet.builder().applyMutation(managedRuleSet).build());
}
/**
*
* A token used for optimistic locking. WAF returns a token to your get and list
* requests, to mark the state of the entity at the time of the request. To make changes to the entity
* associated with the token, you provide the token to operations like update and
* delete. WAF uses the token to ensure that no changes have been made to the entity since you last
* retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If
* this happens, perform another get, and use the new token returned by that operation.
*
*
* @param lockToken
* A token used for optimistic locking. WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To make
* changes to the entity associated with the token, you provide the token to operations like
* update and delete. WAF uses the token to ensure that no changes have been
* made to the entity since you last retrieved it. If a change has been made, the update fails with a
* WAFOptimisticLockException. If this happens, perform another get, and use
* the new token returned by that operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lockToken(String lockToken);
}
static final class BuilderImpl extends Wafv2Response.BuilderImpl implements Builder {
private ManagedRuleSet managedRuleSet;
private String lockToken;
private BuilderImpl() {
}
private BuilderImpl(GetManagedRuleSetResponse model) {
super(model);
managedRuleSet(model.managedRuleSet);
lockToken(model.lockToken);
}
public final ManagedRuleSet.Builder getManagedRuleSet() {
return managedRuleSet != null ? managedRuleSet.toBuilder() : null;
}
public final void setManagedRuleSet(ManagedRuleSet.BuilderImpl managedRuleSet) {
this.managedRuleSet = managedRuleSet != null ? managedRuleSet.build() : null;
}
@Override
public final Builder managedRuleSet(ManagedRuleSet managedRuleSet) {
this.managedRuleSet = managedRuleSet;
return this;
}
public final String getLockToken() {
return lockToken;
}
public final void setLockToken(String lockToken) {
this.lockToken = lockToken;
}
@Override
public final Builder lockToken(String lockToken) {
this.lockToken = lockToken;
return this;
}
@Override
public GetManagedRuleSetResponse build() {
return new GetManagedRuleSetResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}