Package software.amazon.awssdk.services.macie2.model

Class GetFindingsFilterResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.macie2.model.Macie2Response

software.amazon.awssdk.services.macie2.model.GetFindingsFilterResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFindingsFilterResponse.Builder,GetFindingsFilterResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetFindingsFilterResponse
extends Macie2Response
implements ToCopyableBuilder<GetFindingsFilterResponse.Builder,GetFindingsFilterResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetFindingsFilterResponse.Builder

Method Summary

Modifier and Type	Method	Description
FindingsFilterAction	action()	The action that's performed on findings that match the filter criteria (findingCriteria).
String	actionAsString()	The action that's performed on findings that match the filter criteria (findingCriteria).
String	arn()	The Amazon Resource Name (ARN) of the filter.
static GetFindingsFilterResponse.Builder	builder()
String	description()	The custom description of the filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FindingCriteria	findingCriteria()	The criteria that's used to filter findings.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	id()	The unique identifier for the filter.
String	name()	The custom name of 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 GetFindingsFilterResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags()	A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.
GetFindingsFilterResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.macie2.model.Macie2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 that's performed on findings that match the filter criteria (findingCriteria). Possible 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 that's performed on findings that match the filter criteria (findingCriteria). Possible 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 that's performed on findings that match the filter criteria (findingCriteria). Possible 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 that's performed on findings that match the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

See Also:

FindingsFilterAction

arn

public final String arn()

The Amazon Resource Name (ARN) of the filter.

Returns:

The Amazon Resource Name (ARN) of the filter.

description

public final String description()

The custom description of the filter.

Returns:

The custom description of the filter.

findingCriteria

public final FindingCriteria findingCriteria()

The criteria that's used to filter findings.

Returns:

The criteria that's used to filter findings.

id

public final String id()

The unique identifier for the filter.

Returns:

The unique identifier for the filter.

name

public final String name()

The custom name of the filter.

Returns:

The custom name of the filter.

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.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

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

Returns:

A map of key-value pairs that specifies which tags (keys and values) are associated with the filter.

toBuilder

public GetFindingsFilterResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFindingsFilterResponse.Builder,GetFindingsFilterResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetFindingsFilterResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo