software.amazon.awssdk.services.macie2.model

Class UpdateFindingsFilterRequest

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.UpdateFindingsFilterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateFindingsFilterRequest.Builder,UpdateFindingsFilterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateFindingsFilterRequest.Builder

Method Summary

Modifier and Type	Method and Description
FindingsFilterAction	action() The action to perform on findings that match the filter criteria (findingCriteria).
String	actionAsString() The action to perform on findings that match the filter criteria (findingCriteria).
static UpdateFindingsFilterRequest.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()
String	id() The unique identifier for the Amazon Macie resource that the request applies to.
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 UpdateFindingsFilterRequest.Builder>	serializableBuilderClass()
UpdateFindingsFilterRequest.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 final FindingsFilterAction action()

The action to perform on findings that match 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 match 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 final String actionAsString()

The action to perform on findings that match 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 match 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 final 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 final 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 this 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 this description, depending on the actions that they're allowed to perform in Amazon Macie.

findingCriteria

public final FindingCriteria findingCriteria()

The criteria to use to filter findings.

Returns:

The criteria to use to filter findings.

id

public final String id()

The unique identifier for the Amazon Macie resource that the request applies to.

Returns:

The unique identifier for the Amazon Macie resource that the request applies to.

name

public final 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 this 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 this name, depending on the actions that they're allowed to perform in Amazon Macie.

position

public final 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.

toBuilder

public UpdateFindingsFilterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateFindingsFilterRequest.Builder,UpdateFindingsFilterRequest>

Specified by:

toBuilder in class Macie2Request

builder

public static UpdateFindingsFilterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateFindingsFilterRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo