MapFilter (AWS Java SDK for AWS SecurityHub 1.12.376 API)

java.lang.Object
- com.amazonaws.services.securityhub.model.MapFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MapFilter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MapFilter()

Constructors
Constructor and Description
`MapFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MapFilter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComparison()` The condition to apply to the key value when querying for findings with a map filter.
`String`	`getKey()` The key of the map filter.
`String`	`getValue()` The value for the key in the map filter.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setComparison(String comparison)` The condition to apply to the key value when querying for findings with a map filter.
`void`	`setKey(String key)` The key of the map filter.
`void`	`setValue(String value)` The value for the key in the map filter.
`String`	`toString()` Returns a string representation of this object.
`MapFilter`	`withComparison(MapFilterComparison comparison)` The condition to apply to the key value when querying for findings with a map filter.
`MapFilter`	`withComparison(String comparison)` The condition to apply to the key value when querying for findings with a map filter.
`MapFilter`	`withKey(String key)` The key of the map filter.
`MapFilter`	`withValue(String value)` The value for the key in the map filter.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MapFilter
```
public MapFilter()
```
- Method Detail
  - setKey
```
public void setKey(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.
    
    Parameters:
    
    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.
  - getKey
```
public String getKey()
```
    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.
  - withKey
```
public MapFilter withKey(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValue
```
public void setValue(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.
    
    Parameters:
    
    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.
  - getValue
```
public String getValue()
```
    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.
  - withValue
```
public MapFilter withValue(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComparison
```
public void setComparison(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    MapFilterComparison
  - getComparison
```
public String getComparison()
```
    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.
    
    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
  - withComparison
```
public MapFilter withComparison(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MapFilterComparison
  - withComparison
```
public MapFilter withComparison(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MapFilterComparison
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MapFilter clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class MapFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapFilter

Method Detail

setKey

getKey

withKey

setValue

getValue

withValue

setComparison

getComparison

withComparison

withComparison

toString

equals

hashCode

clone

marshall