software.amazon.awssdk.services.codegurusecurity.model

Class MetricsSummary

java.lang.Object

software.amazon.awssdk.services.codegurusecurity.model.MetricsSummary

All Implemented Interfaces:

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

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

Information about summary metrics in an account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricsSummary.Builder

Method Summary

Modifier and Type	Method and Description
static MetricsSummary.Builder	builder()
List<CategoryWithFindingNum>	categoriesWithMostFindings() A list of CategoryWithFindingNum objects for the top 5 finding categories with the most open findings in an account.
Instant	date() The date from which the metrics summary information was retrieved.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCategoriesWithMostFindings() For responses, this returns true if the service returned a value for the CategoriesWithMostFindings property.
int	hashCode()
boolean	hasScansWithMostOpenCriticalFindings() For responses, this returns true if the service returned a value for the ScansWithMostOpenCriticalFindings property.
boolean	hasScansWithMostOpenFindings() For responses, this returns true if the service returned a value for the ScansWithMostOpenFindings property.
FindingMetricsValuePerSeverity	openFindings() The number of open findings of each severity in an account.
List<ScanNameWithFindingNum>	scansWithMostOpenCriticalFindings() A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings in an account.
List<ScanNameWithFindingNum>	scansWithMostOpenFindings() A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings in an account.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricsSummary.Builder>	serializableBuilderClass()
MetricsSummary.Builder	toBuilder()
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

hasCategoriesWithMostFindings

public final boolean hasCategoriesWithMostFindings()

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

categoriesWithMostFindings

public final List<CategoryWithFindingNum> categoriesWithMostFindings()

A list of CategoryWithFindingNum objects for the top 5 finding categories with the most open findings in an account.

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

Returns:

A list of CategoryWithFindingNum objects for the top 5 finding categories with the most open findings in an account.

date

public final Instant date()

The date from which the metrics summary information was retrieved.

Returns:

The date from which the metrics summary information was retrieved.

openFindings

public final FindingMetricsValuePerSeverity openFindings()

The number of open findings of each severity in an account.

Returns:

The number of open findings of each severity in an account.

hasScansWithMostOpenCriticalFindings

public final boolean hasScansWithMostOpenCriticalFindings()

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

scansWithMostOpenCriticalFindings

public final List<ScanNameWithFindingNum> scansWithMostOpenCriticalFindings()

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings in an account.

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

Returns:

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings in an account.

hasScansWithMostOpenFindings

public final boolean hasScansWithMostOpenFindings()

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

scansWithMostOpenFindings

public final List<ScanNameWithFindingNum> scansWithMostOpenFindings()

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings in an account.

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

Returns:

A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings in an account.

toBuilder

public MetricsSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricsSummary.Builder,MetricsSummary>

builder

public static MetricsSummary.Builder builder()

serializableBuilderClass

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