Package software.amazon.awssdk.services.shield.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AttackProperty.Builder

Method Summary

Modifier and Type	Method	Description
AttackLayer	attackLayer()	The type of Shield event that was observed.
String	attackLayerAsString()	The type of Shield event that was observed.
AttackPropertyIdentifier	attackPropertyIdentifier()	Defines the Shield event property information that is provided.
String	attackPropertyIdentifierAsString()	Defines the Shield event property information that is provided.
static AttackProperty.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTopContributors()	For responses, this returns true if the service returned a value for the TopContributors property.
List<SdkField<?>>	sdkFields()
static Class<? extends AttackProperty.Builder>	serializableBuilderClass()
AttackProperty.Builder	toBuilder()
List<Contributor>	topContributors()	Contributor objects for the top five contributors to a Shield event.
String	toString()	Returns a string representation of this object.
Long	total()	The total contributions made to this Shield event by all contributors.
Unit	unit()	The unit used for the Contributor Value property.
String	unitAsString()	The unit used for the Contributor Value property.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AttackLayer

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:

AttackLayer

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:

AttackPropertyIdentifier

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:

AttackPropertyIdentifier

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:

Unit

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:

Unit

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AttackProperty.Builder,AttackProperty>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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