/* * Copyright 2018-2023 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 com.amazonaws.services.shield.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Details of a Shield event. This is provided as part of an AttackDetail. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AttackProperty implements Serializable, Cloneable, StructuredPojo { /** *

* The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events. *

* For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon * CloudWatch metrics. For more information, see Shield * metrics and alarms in the WAF Developer Guide. *

*/ private String attackLayer; /** *

* Defines the Shield event property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and * WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback events. *

*/ private String attackPropertyIdentifier; /** *

* Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that * Shield Advanced identifies as responsible for some or all of an event. *

*/ private java.util.List topContributors; /** *

* The unit used for the Contributor Value property. *

*/ private String unit; /** *

* The total contributions made to this Shield event by all contributors. *

*/ private Long total; /** *

* The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events. *

* * @param attackLayer * The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events.

* For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon * CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide. * @see AttackLayer */ public void setAttackLayer(String attackLayer) { this.attackLayer = attackLayer; } /** *

* The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events. *

* * @return The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events.

* The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events. *

* * @param attackLayer * The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events.

* For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon * CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see AttackLayer */ public AttackProperty withAttackLayer(String attackLayer) { setAttackLayer(attackLayer); return this; } /** *

* The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events. *

* * @param attackLayer * The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and * APPLICATION indicates layer 7 events.

* For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon * CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide. * @return Returns a reference to this object so that method calls can be chained together. * @see AttackLayer */ public AttackProperty withAttackLayer(AttackLayer attackLayer) { this.attackLayer = attackLayer.toString(); return this; } /** *

* * @param attackPropertyIdentifier * Defines the Shield event property information that is provided. The * WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only * for WordPress reflective pingback events. * @see AttackPropertyIdentifier */ public void setAttackPropertyIdentifier(String attackPropertyIdentifier) { this.attackPropertyIdentifier = attackPropertyIdentifier; } /** *

* * @return Defines the Shield event property information that is provided. The * WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid * only for WordPress reflective pingback events. * @see AttackPropertyIdentifier */ public String getAttackPropertyIdentifier() { return this.attackPropertyIdentifier; } /** *

* * @param attackPropertyIdentifier * Defines the Shield event property information that is provided. The * WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only * for WordPress reflective pingback events. * @return Returns a reference to this object so that method calls can be chained together. * @see AttackPropertyIdentifier */ public AttackProperty withAttackPropertyIdentifier(String attackPropertyIdentifier) { setAttackPropertyIdentifier(attackPropertyIdentifier); return this; } /** *

* * @param attackPropertyIdentifier * Defines the Shield event property information that is provided. The * WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only * for WordPress reflective pingback events. * @return Returns a reference to this object so that method calls can be chained together. * @see AttackPropertyIdentifier */ public AttackProperty withAttackPropertyIdentifier(AttackPropertyIdentifier attackPropertyIdentifier) { this.attackPropertyIdentifier = attackPropertyIdentifier.toString(); return this; } /** *

* Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that * Shield Advanced identifies as responsible for some or all of an event. *

* * @return Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic * that Shield Advanced identifies as responsible for some or all of an event. */ public java.util.List getTopContributors() { return topContributors; } /** *

* Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that * Shield Advanced identifies as responsible for some or all of an event. *

* * @param topContributors * Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic * that Shield Advanced identifies as responsible for some or all of an event. */ public void setTopContributors(java.util.Collection topContributors) { if (topContributors == null) { this.topContributors = null; return; } this.topContributors = new java.util.ArrayList(topContributors); } /** *

* Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that * Shield Advanced identifies as responsible for some or all of an event. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTopContributors(java.util.Collection)} or {@link #withTopContributors(java.util.Collection)} if you * want to override the existing values. *

* * @param topContributors * Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic * that Shield Advanced identifies as responsible for some or all of an event. * @return Returns a reference to this object so that method calls can be chained together. */ public AttackProperty withTopContributors(Contributor... topContributors) { if (this.topContributors == null) { setTopContributors(new java.util.ArrayList(topContributors.length)); } for (Contributor ele : topContributors) { this.topContributors.add(ele); } return this; } /** *

* Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that * Shield Advanced identifies as responsible for some or all of an event. *

* * @param topContributors * Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic * that Shield Advanced identifies as responsible for some or all of an event. * @return Returns a reference to this object so that method calls can be chained together. */ public AttackProperty withTopContributors(java.util.Collection topContributors) { setTopContributors(topContributors); return this; } /** *

* The unit used for the Contributor Value property. *

* * @param unit * The unit used for the Contributor Value property. * @see Unit */ public void setUnit(String unit) { this.unit = unit; } /** *

* The unit used for the Contributor Value property. *

* * @return The unit used for the Contributor Value property. * @see Unit */ public String getUnit() { return this.unit; } /** *

* The unit used for the Contributor Value property. *

* * @param unit * The unit used for the Contributor Value property. * @return Returns a reference to this object so that method calls can be chained together. * @see Unit */ public AttackProperty withUnit(String unit) { setUnit(unit); return this; } /** *

* The unit used for the Contributor Value property. *

* The total contributions made to this Shield event by all contributors. *

* * @param total * The total contributions made to this Shield event by all contributors. */ public void setTotal(Long total) { this.total = total; } /** *

* The total contributions made to this Shield event by all contributors. *

* * @return The total contributions made to this Shield event by all contributors. */ public Long getTotal() { return this.total; } /** *

* The total contributions made to this Shield event by all contributors. *

* * @param total * The total contributions made to this Shield event by all contributors. * @return Returns a reference to this object so that method calls can be chained together. */ public AttackProperty withTotal(Long total) { setTotal(total); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAttackLayer() != null) sb.append("AttackLayer: ").append(getAttackLayer()).append(","); if (getAttackPropertyIdentifier() != null) sb.append("AttackPropertyIdentifier: ").append(getAttackPropertyIdentifier()).append(","); if (getTopContributors() != null) sb.append("TopContributors: ").append(getTopContributors()).append(","); if (getUnit() != null) sb.append("Unit: ").append(getUnit()).append(","); if (getTotal() != null) sb.append("Total: ").append(getTotal()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AttackProperty == false) return false; AttackProperty other = (AttackProperty) obj; if (other.getAttackLayer() == null ^ this.getAttackLayer() == null) return false; if (other.getAttackLayer() != null && other.getAttackLayer().equals(this.getAttackLayer()) == false) return false; if (other.getAttackPropertyIdentifier() == null ^ this.getAttackPropertyIdentifier() == null) return false; if (other.getAttackPropertyIdentifier() != null && other.getAttackPropertyIdentifier().equals(this.getAttackPropertyIdentifier()) == false) return false; if (other.getTopContributors() == null ^ this.getTopContributors() == null) return false; if (other.getTopContributors() != null && other.getTopContributors().equals(this.getTopContributors()) == false) return false; if (other.getUnit() == null ^ this.getUnit() == null) return false; if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false) return false; if (other.getTotal() == null ^ this.getTotal() == null) return false; if (other.getTotal() != null && other.getTotal().equals(this.getTotal()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAttackLayer() == null) ? 0 : getAttackLayer().hashCode()); hashCode = prime * hashCode + ((getAttackPropertyIdentifier() == null) ? 0 : getAttackPropertyIdentifier().hashCode()); hashCode = prime * hashCode + ((getTopContributors() == null) ? 0 : getTopContributors().hashCode()); hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode()); hashCode = prime * hashCode + ((getTotal() == null) ? 0 : getTotal().hashCode()); return hashCode; } @Override public AttackProperty clone() { try { return (AttackProperty) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.shield.model.transform.AttackPropertyMarshaller.getInstance().marshall(this, protocolMarshaller); } }