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

Class UsageRecord

java.lang.Object

software.amazon.awssdk.services.macie2.model.UsageRecord

All Implemented Interfaces:

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

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

Provides quota and aggregated usage data for an Amazon Macie account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UsageRecord.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The unique identifier for the Amazon Web Services account that the data applies to.
Instant	automatedDiscoveryFreeTrialStartDate()	The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account.
static UsageRecord.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	freeTrialStartDate()	The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie free trial started for the account.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUsage()	For responses, this returns true if the service returned a value for the Usage property.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageRecord.Builder>	serializableBuilderClass()
UsageRecord.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<UsageByAccount>	usage()	An array of objects that contains usage data and quotas for the account.

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

accountId

public final String accountId()

The unique identifier for the Amazon Web Services account that the data applies to.

Returns:

The unique identifier for the Amazon Web Services account that the data applies to.

automatedDiscoveryFreeTrialStartDate

public final Instant automatedDiscoveryFreeTrialStartDate()

The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account. If the account is a member account in an organization, this value is the same as the value for the organization's Amazon Macie administrator account.

Returns:

The date and time, in UTC and extended ISO 8601 format, when the free trial of automated sensitive data discovery started for the account. If the account is a member account in an organization, this value is the same as the value for the organization's Amazon Macie administrator account.

freeTrialStartDate

public final Instant freeTrialStartDate()

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

Returns:

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

hasUsage

public final boolean hasUsage()

For responses, this returns true if the service returned a value for the Usage 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.

usage

public final List<UsageByAccount> usage()

An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

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

Returns:

An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

toBuilder

public UsageRecord.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageRecord.Builder,UsageRecord>

builder

public static UsageRecord.Builder builder()

serializableBuilderClass

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