MetricsSummary (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codegurusecurity.model

Class MetricsSummary

java.lang.Object
- com.amazonaws.services.codegurusecurity.model.MetricsSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricsSummary
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
A summary of metrics for an account as of a specified date.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricsSummary ()

Constructors
Constructor and Description
`MetricsSummary ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`MetricsSummary`	`clone ()`
`boolean`	`equals (Object obj)`
`List<CategoryWithFindingNum>`	`getCategoriesWithMostFindings ()` A list of `CategoryWithFindingNum` objects for the top 5 finding categories with the most findings.
`Date`	`getDate ()` The date from which the metrics summary information was retrieved.
`FindingMetricsValuePerSeverity`	`getOpenFindings ()` The number of open findings of each severity.
`List<ScanNameWithFindingNum>`	`getScansWithMostOpenCriticalFindings ()` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open critical findings.
`List<ScanNameWithFindingNum>`	`getScansWithMostOpenFindings ()` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open findings.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCategoriesWithMostFindings (Collection<CategoryWithFindingNum> categoriesWithMostFindings)` A list of `CategoryWithFindingNum` objects for the top 5 finding categories with the most findings.
`void`	`setDate (Date date)` The date from which the metrics summary information was retrieved.
`void`	`setOpenFindings (FindingMetricsValuePerSeverity openFindings)` The number of open findings of each severity.
`void`	`setScansWithMostOpenCriticalFindings (Collection<ScanNameWithFindingNum> scansWithMostOpenCriticalFindings)` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open critical findings.
`void`	`setScansWithMostOpenFindings (Collection<ScanNameWithFindingNum> scansWithMostOpenFindings)` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open findings.
`String`	`toString ()` Returns a string representation of this object.
`MetricsSummary`	`withCategoriesWithMostFindings (CategoryWithFindingNum... categoriesWithMostFindings)` A list of `CategoryWithFindingNum` objects for the top 5 finding categories with the most findings.
`MetricsSummary`	`withCategoriesWithMostFindings (Collection<CategoryWithFindingNum> categoriesWithMostFindings)` A list of `CategoryWithFindingNum` objects for the top 5 finding categories with the most findings.
`MetricsSummary`	`withDate (Date date)` The date from which the metrics summary information was retrieved.
`MetricsSummary`	`withOpenFindings (FindingMetricsValuePerSeverity openFindings)` The number of open findings of each severity.
`MetricsSummary`	`withScansWithMostOpenCriticalFindings (Collection<ScanNameWithFindingNum> scansWithMostOpenCriticalFindings)` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open critical findings.
`MetricsSummary`	`withScansWithMostOpenCriticalFindings (ScanNameWithFindingNum... scansWithMostOpenCriticalFindings)` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open critical findings.
`MetricsSummary`	`withScansWithMostOpenFindings (Collection<ScanNameWithFindingNum> scansWithMostOpenFindings)` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open findings.
`MetricsSummary`	`withScansWithMostOpenFindings (ScanNameWithFindingNum... scansWithMostOpenFindings)` A list of `ScanNameWithFindingNum` objects for the top 3 scans with the most number of open findings.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MetricsSummary
```
public MetricsSummary()
```
- Method Detail
  - getCategoriesWithMostFindings
```
public List<CategoryWithFindingNum> getCategoriesWithMostFindings()
```
    A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
    
    Returns:
    
    A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
  - setCategoriesWithMostFindings
```
public void setCategoriesWithMostFindings(Collection<CategoryWithFindingNum> categoriesWithMostFindings)
```
    A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
    
    Parameters:
    
    categoriesWithMostFindings - A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
  - withCategoriesWithMostFindings
```
public MetricsSummary withCategoriesWithMostFindings(CategoryWithFindingNum... categoriesWithMostFindings)
```
    A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
    
    NOTE: This method appends the values to the existing list (if any). Use setCategoriesWithMostFindings(java.util.Collection) or withCategoriesWithMostFindings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    categoriesWithMostFindings - A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCategoriesWithMostFindings
```
public MetricsSummary withCategoriesWithMostFindings(Collection<CategoryWithFindingNum> categoriesWithMostFindings)
```
    A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
    
    Parameters:
    
    categoriesWithMostFindings - A list of CategoryWithFindingNum objects for the top 5 finding categories with the most findings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDate
```
public void setDate(Date date)
```
    The date from which the metrics summary information was retrieved.
    
    Parameters:
    
    date - The date from which the metrics summary information was retrieved.
  - getDate
```
public Date getDate()
```
    The date from which the metrics summary information was retrieved.
    
    Returns:
    
    The date from which the metrics summary information was retrieved.
  - withDate
```
public MetricsSummary withDate(Date date)
```
    The date from which the metrics summary information was retrieved.
    
    Parameters:
    
    date - The date from which the metrics summary information was retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOpenFindings
```
public void setOpenFindings(FindingMetricsValuePerSeverity openFindings)
```
    The number of open findings of each severity.
    
    Parameters:
    
    openFindings - The number of open findings of each severity.
  - getOpenFindings
```
public FindingMetricsValuePerSeverity getOpenFindings()
```
    The number of open findings of each severity.
    
    Returns:
    
    The number of open findings of each severity.
  - withOpenFindings
```
public MetricsSummary withOpenFindings(FindingMetricsValuePerSeverity openFindings)
```
    The number of open findings of each severity.
    
    Parameters:
    
    openFindings - The number of open findings of each severity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getScansWithMostOpenCriticalFindings
```
public List<ScanNameWithFindingNum> getScansWithMostOpenCriticalFindings()
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
    
    Returns:
    
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
  - setScansWithMostOpenCriticalFindings
```
public void setScansWithMostOpenCriticalFindings(Collection<ScanNameWithFindingNum> scansWithMostOpenCriticalFindings)
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
    
    Parameters:
    
    scansWithMostOpenCriticalFindings - A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
  - withScansWithMostOpenCriticalFindings
```
public MetricsSummary withScansWithMostOpenCriticalFindings(ScanNameWithFindingNum... scansWithMostOpenCriticalFindings)
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
    
    NOTE: This method appends the values to the existing list (if any). Use setScansWithMostOpenCriticalFindings(java.util.Collection) or withScansWithMostOpenCriticalFindings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    scansWithMostOpenCriticalFindings - A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withScansWithMostOpenCriticalFindings
```
public MetricsSummary withScansWithMostOpenCriticalFindings(Collection<ScanNameWithFindingNum> scansWithMostOpenCriticalFindings)
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
    
    Parameters:
    
    scansWithMostOpenCriticalFindings - A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open critical findings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getScansWithMostOpenFindings
```
public List<ScanNameWithFindingNum> getScansWithMostOpenFindings()
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
    
    Returns:
    
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
  - setScansWithMostOpenFindings
```
public void setScansWithMostOpenFindings(Collection<ScanNameWithFindingNum> scansWithMostOpenFindings)
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
    
    Parameters:
    
    scansWithMostOpenFindings - A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
  - withScansWithMostOpenFindings
```
public MetricsSummary withScansWithMostOpenFindings(ScanNameWithFindingNum... scansWithMostOpenFindings)
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
    
    NOTE: This method appends the values to the existing list (if any). Use setScansWithMostOpenFindings(java.util.Collection) or withScansWithMostOpenFindings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    scansWithMostOpenFindings - A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withScansWithMostOpenFindings
```
public MetricsSummary withScansWithMostOpenFindings(Collection<ScanNameWithFindingNum> scansWithMostOpenFindings)
```
    A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
    
    Parameters:
    
    scansWithMostOpenFindings - A list of ScanNameWithFindingNum objects for the top 3 scans with the most number of open findings.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MetricsSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class MetricsSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricsSummary

Method Detail

getCategoriesWithMostFindings

setCategoriesWithMostFindings

withCategoriesWithMostFindings

withCategoriesWithMostFindings

setDate

getDate

withDate

setOpenFindings

getOpenFindings

withOpenFindings

getScansWithMostOpenCriticalFindings

setScansWithMostOpenCriticalFindings

withScansWithMostOpenCriticalFindings

withScansWithMostOpenCriticalFindings

getScansWithMostOpenFindings

setScansWithMostOpenFindings

withScansWithMostOpenFindings

withScansWithMostOpenFindings

toString

equals

hashCode

clone

marshall