software.amazon.awssdk.services.guardduty.model

Class UsageStatistics

java.lang.Object

software.amazon.awssdk.services.guardduty.model.UsageStatistics

All Implemented Interfaces:

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

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

Contains the result of GuardDuty usage. If a UsageStatisticType is provided the result for other types will be null.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UsageStatistics.Builder

Method Summary

Modifier and Type	Method and Description
static UsageStatistics.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSumByAccount() For responses, this returns true if the service returned a value for the SumByAccount property.
boolean	hasSumByDataSource() For responses, this returns true if the service returned a value for the SumByDataSource property.
boolean	hasSumByResource() For responses, this returns true if the service returned a value for the SumByResource property.
boolean	hasTopResources() For responses, this returns true if the service returned a value for the TopResources property.
List<SdkField<?>>	sdkFields()
static Class<? extends UsageStatistics.Builder>	serializableBuilderClass()
List<UsageAccountResult>	sumByAccount() The usage statistic sum organized by account ID.
List<UsageDataSourceResult>	sumByDataSource() The usage statistic sum organized by on data source.
List<UsageResourceResult>	sumByResource() The usage statistic sum organized by resource.
UsageStatistics.Builder	toBuilder()
List<UsageResourceResult>	topResources() Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.
String	toString() Returns a string representation of this object.

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

hasSumByAccount

public final boolean hasSumByAccount()

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

sumByAccount

public final List<UsageAccountResult> sumByAccount()

The usage statistic sum organized by account ID.

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

Returns:

The usage statistic sum organized by account ID.

hasSumByDataSource

public final boolean hasSumByDataSource()

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

sumByDataSource

public final List<UsageDataSourceResult> sumByDataSource()

The usage statistic sum organized by on data source.

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

Returns:

The usage statistic sum organized by on data source.

hasSumByResource

public final boolean hasSumByResource()

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

sumByResource

public final List<UsageResourceResult> sumByResource()

The usage statistic sum organized by resource.

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

Returns:

The usage statistic sum organized by resource.

hasTopResources

public final boolean hasTopResources()

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

topResources

public final List<UsageResourceResult> topResources()

Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.

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

Returns:

Lists the top 50 resources that have generated the most GuardDuty usage, in order from most to least expensive.

toBuilder

public UsageStatistics.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UsageStatistics.Builder,UsageStatistics>

builder

public static UsageStatistics.Builder builder()

serializableBuilderClass

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