software.amazon.awssdk.services.fms.model.StatefulRuleGroup Maven / Gradle / Ivy
Show all versions of fms 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.fms.model;
import java.io.Serializable;
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;
/**
*
* Network Firewall stateful rule group, used in a NetworkFirewallPolicyDescription.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class StatefulRuleGroup implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField RULE_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("RuleGroupName").getter(getter(StatefulRuleGroup::ruleGroupName)).setter(setter(Builder::ruleGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("RuleGroupName").build()).build();
private static final SdkField RESOURCE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResourceId").getter(getter(StatefulRuleGroup::resourceId)).setter(setter(Builder::resourceId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResourceId").build()).build();
private static final SdkField PRIORITY_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("Priority").getter(getter(StatefulRuleGroup::priority)).setter(setter(Builder::priority))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Priority").build()).build();
private static final SdkField OVERRIDE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Override")
.getter(getter(StatefulRuleGroup::override)).setter(setter(Builder::override))
.constructor(NetworkFirewallStatefulRuleGroupOverride::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Override").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RULE_GROUP_NAME_FIELD,
RESOURCE_ID_FIELD, PRIORITY_FIELD, OVERRIDE_FIELD));
private static final long serialVersionUID = 1L;
private final String ruleGroupName;
private final String resourceId;
private final Integer priority;
private final NetworkFirewallStatefulRuleGroupOverride override;
private StatefulRuleGroup(BuilderImpl builder) {
this.ruleGroupName = builder.ruleGroupName;
this.resourceId = builder.resourceId;
this.priority = builder.priority;
this.override = builder.override;
}
/**
*
* The name of the rule group.
*
*
* @return The name of the rule group.
*/
public final String ruleGroupName() {
return ruleGroupName;
}
/**
*
* The resource ID of the rule group.
*
*
* @return The resource ID of the rule group.
*/
public final String resourceId() {
return resourceId;
}
/**
*
* An integer setting that indicates the order in which to run the stateful rule groups in a single Network Firewall
* firewall policy. This setting only applies to firewall policies that specify the STRICT_ORDER rule
* order in the stateful engine options settings.
*
*
* Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest
* priority setting. You must ensure that the priority settings are unique within each policy. For information about
*
*
* You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups
* later, number them so there's a wide range in between, for example use 100, 200, and so on.
*
*
* @return An integer setting that indicates the order in which to run the stateful rule groups in a single Network
* Firewall firewall policy. This setting only applies to firewall policies that specify the
* STRICT_ORDER rule order in the stateful engine options settings.
*
* Network Firewall evalutes each stateful rule group against a packet starting with the group that has the
* lowest priority setting. You must ensure that the priority settings are unique within each policy. For
* information about
*
*
* You can change the priority settings of your rule groups at any time. To make it easier to insert rule
* groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
*/
public final Integer priority() {
return priority;
}
/**
*
* The action that allows the policy owner to override the behavior of the rule group within a policy.
*
*
* @return The action that allows the policy owner to override the behavior of the rule group within a policy.
*/
public final NetworkFirewallStatefulRuleGroupOverride override() {
return override;
}
@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 + Objects.hashCode(ruleGroupName());
hashCode = 31 * hashCode + Objects.hashCode(resourceId());
hashCode = 31 * hashCode + Objects.hashCode(priority());
hashCode = 31 * hashCode + Objects.hashCode(override());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StatefulRuleGroup)) {
return false;
}
StatefulRuleGroup other = (StatefulRuleGroup) obj;
return Objects.equals(ruleGroupName(), other.ruleGroupName()) && Objects.equals(resourceId(), other.resourceId())
&& Objects.equals(priority(), other.priority()) && Objects.equals(override(), other.override());
}
/**
* 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("StatefulRuleGroup").add("RuleGroupName", ruleGroupName()).add("ResourceId", resourceId())
.add("Priority", priority()).add("Override", override()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "RuleGroupName":
return Optional.ofNullable(clazz.cast(ruleGroupName()));
case "ResourceId":
return Optional.ofNullable(clazz.cast(resourceId()));
case "Priority":
return Optional.ofNullable(clazz.cast(priority()));
case "Override":
return Optional.ofNullable(clazz.cast(override()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StatefulRuleGroup) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the rule group.
*
*
* @param ruleGroupName
* The name of the rule group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ruleGroupName(String ruleGroupName);
/**
*
* The resource ID of the rule group.
*
*
* @param resourceId
* The resource ID of the rule group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceId(String resourceId);
/**
*
* An integer setting that indicates the order in which to run the stateful rule groups in a single Network
* Firewall firewall policy. This setting only applies to firewall policies that specify the
* STRICT_ORDER rule order in the stateful engine options settings.
*
*
* Network Firewall evalutes each stateful rule group against a packet starting with the group that has the
* lowest priority setting. You must ensure that the priority settings are unique within each policy. For
* information about
*
*
* You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups
* later, number them so there's a wide range in between, for example use 100, 200, and so on.
*
*
* @param priority
* An integer setting that indicates the order in which to run the stateful rule groups in a single
* Network Firewall firewall policy. This setting only applies to firewall policies that specify the
* STRICT_ORDER rule order in the stateful engine options settings.
*
* Network Firewall evalutes each stateful rule group against a packet starting with the group that has
* the lowest priority setting. You must ensure that the priority settings are unique within each policy.
* For information about
*
*
* You can change the priority settings of your rule groups at any time. To make it easier to insert rule
* groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder priority(Integer priority);
/**
*
* The action that allows the policy owner to override the behavior of the rule group within a policy.
*
*
* @param override
* The action that allows the policy owner to override the behavior of the rule group within a policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder override(NetworkFirewallStatefulRuleGroupOverride override);
/**
*
* The action that allows the policy owner to override the behavior of the rule group within a policy.
*
* This is a convenience method that creates an instance of the
* {@link NetworkFirewallStatefulRuleGroupOverride.Builder} avoiding the need to create one manually via
* {@link NetworkFirewallStatefulRuleGroupOverride#builder()}.
*
*
* When the {@link Consumer} completes, {@link NetworkFirewallStatefulRuleGroupOverride.Builder#build()} is
* called immediately and its result is passed to {@link #override(NetworkFirewallStatefulRuleGroupOverride)}.
*
* @param override
* a consumer that will call methods on {@link NetworkFirewallStatefulRuleGroupOverride.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #override(NetworkFirewallStatefulRuleGroupOverride)
*/
default Builder override(Consumer override) {
return override(NetworkFirewallStatefulRuleGroupOverride.builder().applyMutation(override).build());
}
}
static final class BuilderImpl implements Builder {
private String ruleGroupName;
private String resourceId;
private Integer priority;
private NetworkFirewallStatefulRuleGroupOverride override;
private BuilderImpl() {
}
private BuilderImpl(StatefulRuleGroup model) {
ruleGroupName(model.ruleGroupName);
resourceId(model.resourceId);
priority(model.priority);
override(model.override);
}
public final String getRuleGroupName() {
return ruleGroupName;
}
public final void setRuleGroupName(String ruleGroupName) {
this.ruleGroupName = ruleGroupName;
}
@Override
public final Builder ruleGroupName(String ruleGroupName) {
this.ruleGroupName = ruleGroupName;
return this;
}
public final String getResourceId() {
return resourceId;
}
public final void setResourceId(String resourceId) {
this.resourceId = resourceId;
}
@Override
public final Builder resourceId(String resourceId) {
this.resourceId = resourceId;
return this;
}
public final Integer getPriority() {
return priority;
}
public final void setPriority(Integer priority) {
this.priority = priority;
}
@Override
public final Builder priority(Integer priority) {
this.priority = priority;
return this;
}
public final NetworkFirewallStatefulRuleGroupOverride.Builder getOverride() {
return override != null ? override.toBuilder() : null;
}
public final void setOverride(NetworkFirewallStatefulRuleGroupOverride.BuilderImpl override) {
this.override = override != null ? override.build() : null;
}
@Override
public final Builder override(NetworkFirewallStatefulRuleGroupOverride override) {
this.override = override;
return this;
}
@Override
public StatefulRuleGroup build() {
return new StatefulRuleGroup(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}