Package software.amazon.awssdk.services.bcmrecommendedactions.model

Class ActionFilter

java.lang.Object
software.amazon.awssdk.services.bcmrecommendedactions.model.ActionFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ActionFilter.Builder,ActionFilter>
@Generated("software.amazon.awssdk:codegen") public final class ActionFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionFilter.Builder,ActionFilter>

Describes a filter that returns a more specific list of recommended actions.

See Also:

  • Method Details

    • key

      public final FilterName key()

      The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

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

      Returns:
      The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.
      See Also:

    • keyAsString

      public final String keyAsString()

      The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.

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

      Returns:
      The category to filter on. Valid values are FEATURE for feature type, SEVERITY for severity level, and TYPE for recommendation type.
      See Also:

    • matchOption

      public final MatchOption matchOption()

      Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

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

      Returns:
      Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.
      See Also:

    • matchOptionAsString

      public final String matchOptionAsString()

      Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.

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

      Returns:
      Specifies how to apply the filter. Use EQUALS to include matching results or NOT_EQUALS to exclude matching results.
      See Also:

    • hasValues

      public final boolean hasValues()
      For responses, this returns true if the service returned a value for the Values 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.

    • values

      public final List<String> values()

      One or more values to match against the specified key.

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

      Returns:
      One or more values to match against the specified key.

    • toBuilder

      public ActionFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ActionFilter.Builder,ActionFilter>

    • builder

      public static ActionFilter.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo