Class AttackProperty
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AttackProperty.Builder,
AttackProperty>
Details of a Shield event. This is provided as part of an AttackDetail.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AttackLayer
The type of Shield event that was observed.final String
The type of Shield event that was observed.final AttackPropertyIdentifier
Defines the Shield event property information that is provided.final String
Defines the Shield event property information that is provided.static AttackProperty.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TopContributors property.static Class
<? extends AttackProperty.Builder> Take this object and create a builder that contains all of the current property values of this object.final List
<Contributor> Contributor objects for the top five contributors to a Shield event.final String
toString()
Returns a string representation of this object.final Long
total()
The total contributions made to this Shield event by all contributors.final Unit
unit()
The unit used for theContributor
Value
property.final String
The unit used for theContributor
Value
property.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
attackLayer
The type of Shield event that was observed.
NETWORK
indicates layer 3 and layer 4 events andAPPLICATION
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 returnAttackLayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattackLayerAsString()
.- Returns:
- The type of Shield event that was observed.
NETWORK
indicates layer 3 and layer 4 events andAPPLICATION
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
The type of Shield event that was observed.
NETWORK
indicates layer 3 and layer 4 events andAPPLICATION
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 returnAttackLayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattackLayerAsString()
.- Returns:
- The type of Shield event that was observed.
NETWORK
indicates layer 3 and layer 4 events andAPPLICATION
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
Defines the Shield event property information that is provided. The
WORDPRESS_PINGBACK_REFLECTOR
andWORDPRESS_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 returnAttackPropertyIdentifier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattackPropertyIdentifierAsString()
.- Returns:
- Defines the Shield event property information that is provided. The
WORDPRESS_PINGBACK_REFLECTOR
andWORDPRESS_PINGBACK_SOURCE
values are valid only for WordPress reflective pingback events. - See Also:
-
attackPropertyIdentifierAsString
Defines the Shield event property information that is provided. The
WORDPRESS_PINGBACK_REFLECTOR
andWORDPRESS_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 returnAttackPropertyIdentifier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattackPropertyIdentifierAsString()
.- Returns:
- Defines the Shield event property information that is provided. The
WORDPRESS_PINGBACK_REFLECTOR
andWORDPRESS_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 theisEmpty()
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
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
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 returnUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit used for the
Contributor
Value
property. - See Also:
-
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 returnUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit used for the
Contributor
Value
property. - See Also:
-
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
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 interfaceToCopyableBuilder<AttackProperty.Builder,
AttackProperty> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-