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>

  • Method Details

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

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

    • 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()
      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 interface ToCopyableBuilder<GetFindingsFilterResponse.Builder,GetFindingsFilterResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.