CreateFindingsFilterRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.macie2.model.Macie2Request
    - - software.amazon.awssdk.services.macie2.model.CreateFindingsFilterRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateFindingsFilterRequest.Builder,CreateFindingsFilterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFindingsFilterRequest
extends Macie2Request
implements ToCopyableBuilder<CreateFindingsFilterRequest.Builder,CreateFindingsFilterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateFindingsFilterRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateFindingsFilterRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FindingsFilterAction`	`action()` The action to perform on findings that meet the filter criteria (findingCriteria).
`String`	`actionAsString()` The action to perform on findings that meet the filter criteria (findingCriteria).
`static CreateFindingsFilterRequest.Builder`	`builder()`
`String`	`clientToken()` A unique, case-sensitive token that you provide to ensure the idempotency of the request.
`String`	`description()` A custom description of the filter.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FindingCriteria`	`findingCriteria()` The criteria to use to filter findings.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`name()` A custom name for the filter.
`Integer`	`position()` The position of the filter in the list of saved filters on the Amazon Macie console.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateFindingsFilterRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A map of key-value pairs that specifies the tags to associate with the filter.
`CreateFindingsFilterRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - action
```
public FindingsFilterAction action()
```
    The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
    
    If the service returns an enum value that is not available in the current SDK version, action will return FindingsFilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
    
    See Also:
    
    FindingsFilterAction
  - actionAsString
```
public String actionAsString()
```
    The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
    
    If the service returns an enum value that is not available in the current SDK version, action will return FindingsFilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    
    Returns:
    
    The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
    
    See Also:
    
    FindingsFilterAction
  - clientToken
```
public String clientToken()
```
    A unique, case-sensitive token that you provide to ensure the idempotency of the request.
    
    Returns:
    
    A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  - description
```
public String description()
```
    A custom description of the filter. The description can contain as many as 512 characters.
    
    We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
    
    Returns:
    
    A custom description of the filter. The description can contain as many as 512 characters.
    
    We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
  - findingCriteria
```
public FindingCriteria findingCriteria()
```
    The criteria to use to filter findings.
    
    Returns:
    
    The criteria to use to filter findings.
  - name
```
public String name()
```
    A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
    
    We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
    
    Returns:
    
    A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
    
    We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
  - position
```
public Integer position()
```
    The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
    
    Returns:
    
    The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    A map of key-value pairs that specifies the tags to associate with the filter.
    
    A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A map of key-value pairs that specifies the tags to associate with the filter.
    
    A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
  - toBuilder
```
public CreateFindingsFilterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFindingsFilterRequest.Builder,CreateFindingsFilterRequest>
    
    Specified by:
    
    toBuilder in class Macie2Request
  - builder
```
public static CreateFindingsFilterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFindingsFilterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateFindingsFilterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

action

actionAsString

clientToken

description

findingCriteria

name

position

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields