Package software.amazon.awssdk.services.macie2.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsageStatisticsFilter.Builder

Method Summary

Modifier and Type	Method	Description
static UsageStatisticsFilter.Builder	builder()
UsageStatisticsFilterComparator	comparator()	The operator to use in the condition.
String	comparatorAsString()	The operator to use in the condition.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
UsageStatisticsFilterKey	key()	The field to use in the condition.
String	keyAsString()	The field to use in the condition.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageStatisticsFilter.Builder>	serializableBuilderClass()
UsageStatisticsFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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.

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

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:

UsageStatisticsFilterComparator

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:

UsageStatisticsFilterComparator

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:

UsageStatisticsFilterKey

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:

UsageStatisticsFilterKey

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()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageStatisticsFilter.Builder,UsageStatisticsFilter>

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)

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