Class UsageStatisticsFilter

java.lang.Object
software.amazon.awssdk.services.macie2.model.UsageStatisticsFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UsageStatisticsFilter.Builder,UsageStatisticsFilter>

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

Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.

See Also:
  • Method Details

    • comparator

      public final UsageStatisticsFilterComparator comparator()

      The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

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

      Returns:
      The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.
      See Also:
    • comparatorAsString

      public final String comparatorAsString()

      The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

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

      Returns:
      The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.
      See Also:
    • key

      public final UsageStatisticsFilterKey key()

      The field to use in the condition.

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

      Returns:
      The field to use in the condition.
      See Also:
    • keyAsString

      public final String keyAsString()

      The field to use in the condition.

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

      Returns:
      The field to use in the condition.
      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()

      An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

      Valid values for each supported field are:

      • accountId - The unique identifier for an Amazon Web Services account.

      • freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for an account.

      • serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.

      • total - A string that represents the current estimated cost for an account.

      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:
      An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

      Valid values for each supported field are:

      • accountId - The unique identifier for an Amazon Web Services account.

      • freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for an account.

      • serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.

      • total - A string that represents the current estimated cost for an account.

    • toBuilder

      public UsageStatisticsFilter.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<UsageStatisticsFilter.Builder,UsageStatisticsFilter>
      Returns:
      a builder for type T
    • builder

      public static UsageStatisticsFilter.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UsageStatisticsFilter.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)
      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)
    • 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.