Package software.amazon.awssdk.services.guardduty.model

Class Indicator

java.lang.Object

software.amazon.awssdk.services.guardduty.model.Indicator

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Indicator.Builder,Indicator>

@Generated("software.amazon.awssdk:codegen")
public final class Indicator
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Indicator.Builder,Indicator>

Contains information about the indicators that include a set of signals observed in an attack sequence.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Indicator.Builder

Method Summary

Modifier and Type	Method	Description
static Indicator.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
IndicatorType	key()	Specific indicator keys observed in the attack sequence.
String	keyAsString()	Specific indicator keys observed in the attack sequence.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Indicator.Builder>	serializableBuilderClass()
String	title()	Title describing the indicator.
Indicator.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	Values associated with each indicator key.

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

key

public final IndicatorType key()

Specific indicator keys observed in the attack sequence.

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

Returns:

Specific indicator keys observed in the attack sequence.

See Also:

IndicatorType

keyAsString

public final String keyAsString()

Specific indicator keys observed in the attack sequence.

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

Returns:

Specific indicator keys observed in the attack sequence.

See Also:

IndicatorType

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values 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.

values

public final List<String> values()

Values associated with each indicator key. For example, if the indicator key is SUSPICIOUS_NETWORK, then the value will be the name of the network. If the indicator key is ATTACK_TACTIC, then the value will be one of the MITRE tactics.

For more information about the values associated with the key, see GuardDuty Extended Threat Detection in the GuardDuty User Guide.

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

Returns:

Values associated with each indicator key. For example, if the indicator key is SUSPICIOUS_NETWORK, then the value will be the name of the network. If the indicator key is ATTACK_TACTIC, then the value will be one of the MITRE tactics.

For more information about the values associated with the key, see GuardDuty Extended Threat Detection in the GuardDuty User Guide.

title

public final String title()

Title describing the indicator.

Returns:

Title describing the indicator.

toBuilder

public Indicator.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Indicator.Builder,Indicator>

builder

public static Indicator.Builder builder()

serializableBuilderClass

public static Class<? extends Indicator.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo