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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSumByAccount() Returns true if the SumByAccount property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSumByDataSource() Returns true if the SumByDataSource property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSumByResource() Returns true if the SumByResource property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTopResources() Returns true if the TopResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasSumByAccount

public final boolean hasSumByAccount()

Returns true if the SumByAccount property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasSumByAccount() to see if a value was sent in this field.

Returns:

The usage statistic sum organized by account ID.

hasSumByDataSource

public final boolean hasSumByDataSource()

Returns true if the SumByDataSource property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasSumByDataSource() to see if a value was sent in this field.

Returns:

The usage statistic sum organized by on data source.

hasSumByResource

public final boolean hasSumByResource()

Returns true if the SumByResource property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasSumByResource() to see if a value was sent in this field.

Returns:

The usage statistic sum organized by resource.

hasTopResources

public final boolean hasTopResources()

Returns true if the TopResources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTopResources() to see if a value was sent in this field.

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

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<UsageStatistics.Builder,UsageStatistics>

Returns:

a builder for type T

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)

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.