Package software.amazon.awssdk.services.inspector2.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.inspector2.model.Filter

All Implemented Interfaces:

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

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

Details about a filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method	Description
FilterAction	action()	The action that is to be applied to the findings that match the filter.
String	actionAsString()	The action that is to be applied to the findings that match the filter.
String	arn()	The Amazon Resource Number (ARN) associated with this filter.
static Filter.Builder	builder()
Instant	createdAt()	The date and time this filter was created at.
FilterCriteria	criteria()	Details on the filter criteria associated with this filter.
String	description()	A description of the filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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	name()	The name of the filter.
String	ownerId()	The Amazon Web Services account ID of the account that created the filter.
String	reason()	The reason for the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags attached to the filter.
Filter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The date and time the filter was last updated at.

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 FilterAction action()

The action that is to be applied to the findings that match the filter.

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

Returns:

The action that is to be applied to the findings that match the filter.

See Also:

FilterAction

actionAsString

public final String actionAsString()

The action that is to be applied to the findings that match the filter.

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

Returns:

The action that is to be applied to the findings that match the filter.

See Also:

FilterAction

arn

public final String arn()

The Amazon Resource Number (ARN) associated with this filter.

Returns:

The Amazon Resource Number (ARN) associated with this filter.

createdAt

public final Instant createdAt()

The date and time this filter was created at.

Returns:

The date and time this filter was created at.

criteria

public final FilterCriteria criteria()

Details on the filter criteria associated with this filter.

Returns:

Details on the filter criteria associated with this filter.

description

public final String description()

A description of the filter.

Returns:

A description of the filter.

name

public final String name()

The name of the filter.

Returns:

The name of the filter.

ownerId

public final String ownerId()

The Amazon Web Services account ID of the account that created the filter.

Returns:

The Amazon Web Services account ID of the account that created the filter.

reason

public final String reason()

The reason for the filter.

Returns:

The reason for the filter.

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

The tags attached to 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:

The tags attached to the filter.

updatedAt

public final Instant updatedAt()

The date and time the filter was last updated at.

Returns:

The date and time the filter was last updated at.

toBuilder

public Filter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

builder

public static Filter.Builder builder()

serializableBuilderClass

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