software.amazon.awssdk.services.securityhub.model

Class MapFilter

java.lang.Object

software.amazon.awssdk.services.securityhub.model.MapFilter

All Implemented Interfaces:

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

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

A map filter for querying findings. Each map filter provides the field to check, the value to look for, and the comparison operator.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MapFilter.Builder

Method Summary

Modifier and Type	Method and Description
static MapFilter.Builder	builder()
MapFilterComparison	comparison() The condition to apply to the key value when querying for findings with a map filter.
String	comparisonAsString() The condition to apply to the key value when querying for findings with a map filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() The key of the map filter.
List<SdkField<?>>	sdkFields()
static Class<? extends MapFilter.Builder>	serializableBuilderClass()
MapFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	value() The value for the key in the map filter.

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

The key of the map filter. For example, for ResourceTags, Key identifies the name of the tag. For UserDefinedFields, Key is the name of the field.

Returns:

The key of the map filter. For example, for ResourceTags, Key identifies the name of the tag. For UserDefinedFields, Key is the name of the field.

value

public final String value()

The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called Department might be Security. If you provide security as the filter value, then there is no match.

Returns:

The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called Department might be Security. If you provide security as the filter value, then there is no match.

comparison

public final MapFilterComparison comparison()

The condition to apply to the key value when querying for findings with a map filter.

To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the tag Department.

To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that do not have the value Finance for the tag Department.

EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters.

NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters.

You cannot have both an EQUALS filter and a NOT_EQUALS filter on the same field.

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

Returns:

The condition to apply to the key value when querying for findings with a map filter.

To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the tag Department.

To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that do not have the value Finance for the tag Department.

EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters.

NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters.

You cannot have both an EQUALS filter and a NOT_EQUALS filter on the same field.

See Also:

MapFilterComparison

comparisonAsString

public final String comparisonAsString()

The condition to apply to the key value when querying for findings with a map filter.

To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the tag Department.

To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that do not have the value Finance for the tag Department.

EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters.

NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters.

You cannot have both an EQUALS filter and a NOT_EQUALS filter on the same field.

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

Returns:

The condition to apply to the key value when querying for findings with a map filter.

To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the tag Department.

To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that do not have the value Finance for the tag Department.

EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters.

NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters.

You cannot have both an EQUALS filter and a NOT_EQUALS filter on the same field.

See Also:

MapFilterComparison

toBuilder

public MapFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MapFilter.Builder,MapFilter>

builder

public static MapFilter.Builder builder()

serializableBuilderClass

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