Class AttackProperty

java.lang.Object
software.amazon.awssdk.services.shield.model.AttackProperty
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AttackProperty.Builder,AttackProperty>
@Generated("software.amazon.awssdk:codegen") public final class AttackProperty extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttackProperty.Builder,AttackProperty>

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

See Also:

  • Method Details

    • attackLayer

      public final AttackLayer 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.

      If the service returns an enum value that is not available in the current SDK version, attackLayer will return AttackLayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attackLayerAsString().

      Returns:
      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 Also:

    • attackLayerAsString

      public final String attackLayerAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, attackLayer will return AttackLayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attackLayerAsString().

      Returns:
      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 Also:

    • attackPropertyIdentifier

      public final AttackPropertyIdentifier 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.

      If the service returns an enum value that is not available in the current SDK version, attackPropertyIdentifier will return AttackPropertyIdentifier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attackPropertyIdentifierAsString().

      Returns:
      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 Also:

    • attackPropertyIdentifierAsString

      public final String attackPropertyIdentifierAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, attackPropertyIdentifier will return AttackPropertyIdentifier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attackPropertyIdentifierAsString().

      Returns:
      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 Also:

    • hasTopContributors

      public final boolean hasTopContributors()
      For responses, this returns true if the service returned a value for the TopContributors property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • topContributors

      public final List<Contributor> 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.

      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 hasTopContributors() method.

      Returns:
      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.

    • unit

      public final Unit unit()

      The unit used for the Contributor Value property.

      If the service returns an enum value that is not available in the current SDK version, unit will return Unit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      Returns:
      The unit used for the Contributor Value property.
      See Also:

    • unitAsString

      public final String unitAsString()

      The unit used for the Contributor Value property.

      If the service returns an enum value that is not available in the current SDK version, unit will return Unit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      Returns:
      The unit used for the Contributor Value property.
      See Also:

    • total

      public final Long total()

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

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

    • toBuilder

      public AttackProperty.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AttackProperty.Builder,AttackProperty>
      Returns:
      a builder for type T

    • builder

      public static AttackProperty.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttackProperty.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.