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

Class UsageTotal

java.lang.Object

software.amazon.awssdk.services.macie2.model.UsageTotal

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UsageTotal.Builder,UsageTotal>

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

Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsageTotal.Builder

Method Summary

Modifier and Type	Method	Description
static UsageTotal.Builder	builder()
Currency	currency()	The type of currency that the value for the metric (estimatedCost) is reported in.
String	currencyAsString()	The type of currency that the value for the metric (estimatedCost) is reported in.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	estimatedCost()	The estimated value for the metric.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends UsageTotal.Builder>	serializableBuilderClass()
UsageTotal.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UsageType	type()	The name of the metric.
String	typeAsString()	The name of the metric.

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

currency

public final Currency currency()

The type of currency that the value for the metric (estimatedCost) is reported in.

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

Returns:

The type of currency that the value for the metric (estimatedCost) is reported in.

See Also:

Currency

currencyAsString

public final String currencyAsString()

The type of currency that the value for the metric (estimatedCost) is reported in.

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

Returns:

The type of currency that the value for the metric (estimatedCost) is reported in.

See Also:

Currency

estimatedCost

public final String estimatedCost()

The estimated value for the metric.

Returns:

The estimated value for the metric.

type

public final UsageType type()

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

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

Returns:

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

See Also:

UsageType

typeAsString

public final String typeAsString()

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

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

Returns:

The name of the metric. Possible values are: AUTOMATED_OBJECT_MONITORING, to monitor S3 objects for automated sensitive data discovery; AUTOMATED_SENSITIVE_DATA_DISCOVERY, to analyze S3 objects for automated sensitive data discovery; DATA_INVENTORY_EVALUATION, to monitor S3 buckets; and, SENSITIVE_DATA_DISCOVERY, to run classification jobs.

See Also:

UsageType

toBuilder

public UsageTotal.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageTotal.Builder,UsageTotal>

builder

public static UsageTotal.Builder builder()

serializableBuilderClass

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