software.amazon.awssdk.services.wafv2.model.ManagedRuleSetVersion 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.io.Serializable;
import java.time.Instant;
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.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;
/**
*
* Information for a single version of a managed rule set.
*
*
*
* This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web
* Services Marketplace sellers.
*
*
* Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group
* offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet,
* PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ManagedRuleSetVersion implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ASSOCIATED_RULE_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AssociatedRuleGroupArn").getter(getter(ManagedRuleSetVersion::associatedRuleGroupArn))
.setter(setter(Builder::associatedRuleGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AssociatedRuleGroupArn").build())
.build();
private static final SdkField CAPACITY_FIELD = SdkField. builder(MarshallingType.LONG).memberName("Capacity")
.getter(getter(ManagedRuleSetVersion::capacity)).setter(setter(Builder::capacity))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Capacity").build()).build();
private static final SdkField FORECASTED_LIFETIME_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("ForecastedLifetime").getter(getter(ManagedRuleSetVersion::forecastedLifetime))
.setter(setter(Builder::forecastedLifetime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ForecastedLifetime").build())
.build();
private static final SdkField PUBLISH_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("PublishTimestamp").getter(getter(ManagedRuleSetVersion::publishTimestamp))
.setter(setter(Builder::publishTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PublishTimestamp").build()).build();
private static final SdkField LAST_UPDATE_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdateTimestamp").getter(getter(ManagedRuleSetVersion::lastUpdateTimestamp))
.setter(setter(Builder::lastUpdateTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdateTimestamp").build())
.build();
private static final SdkField EXPIRY_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("ExpiryTimestamp").getter(getter(ManagedRuleSetVersion::expiryTimestamp))
.setter(setter(Builder::expiryTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExpiryTimestamp").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
ASSOCIATED_RULE_GROUP_ARN_FIELD, CAPACITY_FIELD, FORECASTED_LIFETIME_FIELD, PUBLISH_TIMESTAMP_FIELD,
LAST_UPDATE_TIMESTAMP_FIELD, EXPIRY_TIMESTAMP_FIELD));
private static final long serialVersionUID = 1L;
private final String associatedRuleGroupArn;
private final Long capacity;
private final Integer forecastedLifetime;
private final Instant publishTimestamp;
private final Instant lastUpdateTimestamp;
private final Instant expiryTimestamp;
private ManagedRuleSetVersion(BuilderImpl builder) {
this.associatedRuleGroupArn = builder.associatedRuleGroupArn;
this.capacity = builder.capacity;
this.forecastedLifetime = builder.forecastedLifetime;
this.publishTimestamp = builder.publishTimestamp;
this.lastUpdateTimestamp = builder.lastUpdateTimestamp;
this.expiryTimestamp = builder.expiryTimestamp;
}
/**
*
* The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your
* managed rule group.
*
*
* @return The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of
* your managed rule group.
*/
public final String associatedRuleGroupArn() {
return associatedRuleGroupArn;
}
/**
*
* The web ACL capacity units (WCUs) required for this rule group.
*
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and
* web ACLs. 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.
* For more information, see WAF web ACL capacity
* units (WCU) in the WAF Developer Guide.
*
*
* @return The web ACL capacity units (WCUs) required for this rule group.
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. 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. For more information, see WAF web ACL
* capacity units (WCU) in the WAF Developer Guide.
*/
public final Long capacity() {
return capacity;
}
/**
*
* The amount of time you expect this version of your managed rule group to last, in days.
*
*
* @return The amount of time you expect this version of your managed rule group to last, in days.
*/
public final Integer forecastedLifetime() {
return forecastedLifetime;
}
/**
*
* The time that you first published this version.
*
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example,
* "2016-09-27T14:50Z".
*
*
* @return The time that you first published this version.
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
* example, "2016-09-27T14:50Z".
*/
public final Instant publishTimestamp() {
return publishTimestamp;
}
/**
*
* The last time that you updated this version.
*
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example,
* "2016-09-27T14:50Z".
*
*
* @return The last time that you updated this version.
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
* example, "2016-09-27T14:50Z".
*/
public final Instant lastUpdateTimestamp() {
return lastUpdateTimestamp;
}
/**
*
* The time that this version is set to expire.
*
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example,
* "2016-09-27T14:50Z".
*
*
* @return The time that this version is set to expire.
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
* example, "2016-09-27T14:50Z".
*/
public final Instant expiryTimestamp() {
return expiryTimestamp;
}
@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(associatedRuleGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(capacity());
hashCode = 31 * hashCode + Objects.hashCode(forecastedLifetime());
hashCode = 31 * hashCode + Objects.hashCode(publishTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdateTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(expiryTimestamp());
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 ManagedRuleSetVersion)) {
return false;
}
ManagedRuleSetVersion other = (ManagedRuleSetVersion) obj;
return Objects.equals(associatedRuleGroupArn(), other.associatedRuleGroupArn())
&& Objects.equals(capacity(), other.capacity())
&& Objects.equals(forecastedLifetime(), other.forecastedLifetime())
&& Objects.equals(publishTimestamp(), other.publishTimestamp())
&& Objects.equals(lastUpdateTimestamp(), other.lastUpdateTimestamp())
&& Objects.equals(expiryTimestamp(), other.expiryTimestamp());
}
/**
* 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("ManagedRuleSetVersion").add("AssociatedRuleGroupArn", associatedRuleGroupArn())
.add("Capacity", capacity()).add("ForecastedLifetime", forecastedLifetime())
.add("PublishTimestamp", publishTimestamp()).add("LastUpdateTimestamp", lastUpdateTimestamp())
.add("ExpiryTimestamp", expiryTimestamp()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AssociatedRuleGroupArn":
return Optional.ofNullable(clazz.cast(associatedRuleGroupArn()));
case "Capacity":
return Optional.ofNullable(clazz.cast(capacity()));
case "ForecastedLifetime":
return Optional.ofNullable(clazz.cast(forecastedLifetime()));
case "PublishTimestamp":
return Optional.ofNullable(clazz.cast(publishTimestamp()));
case "LastUpdateTimestamp":
return Optional.ofNullable(clazz.cast(lastUpdateTimestamp()));
case "ExpiryTimestamp":
return Optional.ofNullable(clazz.cast(expiryTimestamp()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ManagedRuleSetVersion) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your
* managed rule group.
*
*
* @param associatedRuleGroupArn
* The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of
* your managed rule group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder associatedRuleGroupArn(String associatedRuleGroupArn);
/**
*
* The web ACL capacity units (WCUs) required for this rule group.
*
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups,
* and web ACLs. 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. For more information, see WAF web ACL capacity
* units (WCU) in the WAF Developer Guide.
*
*
* @param capacity
* The web ACL capacity units (WCUs) required for this rule group.
*
* WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule
* groups, and web ACLs. 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. For more information, see WAF web ACL
* capacity units (WCU) in the WAF Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capacity(Long capacity);
/**
*
* The amount of time you expect this version of your managed rule group to last, in days.
*
*
* @param forecastedLifetime
* The amount of time you expect this version of your managed rule group to last, in days.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder forecastedLifetime(Integer forecastedLifetime);
/**
*
* The time that you first published this version.
*
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
* example, "2016-09-27T14:50Z".
*
*
* @param publishTimestamp
* The time that you first published this version.
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z.
* For example, "2016-09-27T14:50Z".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder publishTimestamp(Instant publishTimestamp);
/**
*
* The last time that you updated this version.
*
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
* example, "2016-09-27T14:50Z".
*
*
* @param lastUpdateTimestamp
* The last time that you updated this version.
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z.
* For example, "2016-09-27T14:50Z".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdateTimestamp(Instant lastUpdateTimestamp);
/**
*
* The time that this version is set to expire.
*
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For
* example, "2016-09-27T14:50Z".
*
*
* @param expiryTimestamp
* The time that this version is set to expire.
*
* Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z.
* For example, "2016-09-27T14:50Z".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expiryTimestamp(Instant expiryTimestamp);
}
static final class BuilderImpl implements Builder {
private String associatedRuleGroupArn;
private Long capacity;
private Integer forecastedLifetime;
private Instant publishTimestamp;
private Instant lastUpdateTimestamp;
private Instant expiryTimestamp;
private BuilderImpl() {
}
private BuilderImpl(ManagedRuleSetVersion model) {
associatedRuleGroupArn(model.associatedRuleGroupArn);
capacity(model.capacity);
forecastedLifetime(model.forecastedLifetime);
publishTimestamp(model.publishTimestamp);
lastUpdateTimestamp(model.lastUpdateTimestamp);
expiryTimestamp(model.expiryTimestamp);
}
public final String getAssociatedRuleGroupArn() {
return associatedRuleGroupArn;
}
public final void setAssociatedRuleGroupArn(String associatedRuleGroupArn) {
this.associatedRuleGroupArn = associatedRuleGroupArn;
}
@Override
public final Builder associatedRuleGroupArn(String associatedRuleGroupArn) {
this.associatedRuleGroupArn = associatedRuleGroupArn;
return this;
}
public final Long getCapacity() {
return capacity;
}
public final void setCapacity(Long capacity) {
this.capacity = capacity;
}
@Override
public final Builder capacity(Long capacity) {
this.capacity = capacity;
return this;
}
public final Integer getForecastedLifetime() {
return forecastedLifetime;
}
public final void setForecastedLifetime(Integer forecastedLifetime) {
this.forecastedLifetime = forecastedLifetime;
}
@Override
public final Builder forecastedLifetime(Integer forecastedLifetime) {
this.forecastedLifetime = forecastedLifetime;
return this;
}
public final Instant getPublishTimestamp() {
return publishTimestamp;
}
public final void setPublishTimestamp(Instant publishTimestamp) {
this.publishTimestamp = publishTimestamp;
}
@Override
public final Builder publishTimestamp(Instant publishTimestamp) {
this.publishTimestamp = publishTimestamp;
return this;
}
public final Instant getLastUpdateTimestamp() {
return lastUpdateTimestamp;
}
public final void setLastUpdateTimestamp(Instant lastUpdateTimestamp) {
this.lastUpdateTimestamp = lastUpdateTimestamp;
}
@Override
public final Builder lastUpdateTimestamp(Instant lastUpdateTimestamp) {
this.lastUpdateTimestamp = lastUpdateTimestamp;
return this;
}
public final Instant getExpiryTimestamp() {
return expiryTimestamp;
}
public final void setExpiryTimestamp(Instant expiryTimestamp) {
this.expiryTimestamp = expiryTimestamp;
}
@Override
public final Builder expiryTimestamp(Instant expiryTimestamp) {
this.expiryTimestamp = expiryTimestamp;
return this;
}
@Override
public ManagedRuleSetVersion build() {
return new ManagedRuleSetVersion(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}