software.amazon.awssdk.services.guardduty.model

Class GetFilterResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.guardduty.model.GuardDutyResponse

software.amazon.awssdk.services.guardduty.model.GetFilterResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetFilterResponse.Builder,GetFilterResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetFilterResponse.Builder

Method Summary

Modifier and Type	Method and Description
FilterAction	action() Specifies the action that is to be applied to the findings that match the filter.
String	actionAsString() Specifies the action that is to be applied to the findings that match the filter.
static GetFilterResponse.Builder	builder()
String	description() The description of the filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FindingCriteria	findingCriteria() Represents the criteria to be used in the filter for querying 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	name() The name of the filter.
Integer	rank() Specifies the position of the filter in the list of current filters.
List<SdkField<?>>	sdkFields()
static Class<? extends GetFilterResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags of the filter resource.
GetFilterResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.guardduty.model.GuardDutyResponse

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

name

public final String name()

The name of the filter.

Returns:

The name of the filter.

description

public final String description()

The description of the filter.

Returns:

The description of the filter.

action

public final FilterAction action()

Specifies 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:

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

See Also:

FilterAction

actionAsString

public final String actionAsString()

Specifies 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:

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

See Also:

FilterAction

rank

public final Integer rank()

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

Returns:

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

findingCriteria

public final FindingCriteria findingCriteria()

Represents the criteria to be used in the filter for querying findings.

Returns:

Represents the criteria to be used in the filter for querying 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()

The tags of the filter resource.

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 of the filter resource.

toBuilder

public GetFilterResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFilterResponse.Builder,GetFilterResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetFilterResponse.Builder builder()

serializableBuilderClass

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