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:

  • Method Details

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

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

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

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

    • toBuilder

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

    • 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)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.