Class GetFilterResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetFilterResponse.Builder,
GetFilterResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal FilterAction
action()
Specifies the action that is to be applied to the findings that match the filter.final String
Specifies the action that is to be applied to the findings that match the filter.static GetFilterResponse.Builder
builder()
final String
The description of the filter.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FindingCriteria
Represents the criteria to be used in the filter for querying findings.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The name of the filter.final Integer
rank()
Specifies the position of the filter in the list of current filters.static Class
<? extends GetFilterResponse.Builder> tags()
The tags of the filter resource.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the filter.
- Returns:
- The name of the filter.
-
description
The description of the filter.
- Returns:
- The description of the filter.
-
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 returnFilterAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- Specifies the action that is to be applied to the findings that match the filter.
- See Also:
-
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 returnFilterAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- Specifies the action that is to be applied to the findings that match the filter.
- See Also:
-
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetFilterResponse.Builder,
GetFilterResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-