software.amazon.awssdk.services.codegurusecurity.model.MetricsSummary Maven / Gradle / Ivy
Show all versions of codegurusecurity Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.codegurusecurity.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* A summary of metrics for an account as of a specified date.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MetricsSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> CATEGORIES_WITH_MOST_FINDINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("categoriesWithMostFindings")
.getter(getter(MetricsSummary::categoriesWithMostFindings))
.setter(setter(Builder::categoriesWithMostFindings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("categoriesWithMostFindings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CategoryWithFindingNum::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DATE_FIELD = SdkField. builder(MarshallingType.INSTANT).memberName("date")
.getter(getter(MetricsSummary::date)).setter(setter(Builder::date))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("date").build()).build();
private static final SdkField OPEN_FINDINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("openFindings")
.getter(getter(MetricsSummary::openFindings)).setter(setter(Builder::openFindings))
.constructor(FindingMetricsValuePerSeverity::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("openFindings").build()).build();
private static final SdkField> SCANS_WITH_MOST_OPEN_CRITICAL_FINDINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("scansWithMostOpenCriticalFindings")
.getter(getter(MetricsSummary::scansWithMostOpenCriticalFindings))
.setter(setter(Builder::scansWithMostOpenCriticalFindings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("scansWithMostOpenCriticalFindings")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ScanNameWithFindingNum::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SCANS_WITH_MOST_OPEN_FINDINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("scansWithMostOpenFindings")
.getter(getter(MetricsSummary::scansWithMostOpenFindings))
.setter(setter(Builder::scansWithMostOpenFindings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("scansWithMostOpenFindings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ScanNameWithFindingNum::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
CATEGORIES_WITH_MOST_FINDINGS_FIELD, DATE_FIELD, OPEN_FINDINGS_FIELD, SCANS_WITH_MOST_OPEN_CRITICAL_FINDINGS_FIELD,
SCANS_WITH_MOST_OPEN_FINDINGS_FIELD));
private static final long serialVersionUID = 1L;
private final List categoriesWithMostFindings;
private final Instant date;
private final FindingMetricsValuePerSeverity openFindings;
private final List scansWithMostOpenCriticalFindings;
private final List scansWithMostOpenFindings;
private MetricsSummary(BuilderImpl builder) {
this.categoriesWithMostFindings = builder.categoriesWithMostFindings;
this.date = builder.date;
this.openFindings = builder.openFindings;
this.scansWithMostOpenCriticalFindings = builder.scansWithMostOpenCriticalFindings;
this.scansWithMostOpenFindings = builder.scansWithMostOpenFindings;
}
/**
* 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 {@code 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.
*/
public final boolean hasCategoriesWithMostFindings() {
return categoriesWithMostFindings != null && !(categoriesWithMostFindings instanceof SdkAutoConstructList);
}
/**
*
* A list of CategoryWithFindingNum
objects for the top 5 finding categories with the most findings.
*
*
* 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 {@link #hasCategoriesWithMostFindings} method.
*
*
* @return A list of CategoryWithFindingNum
objects for the top 5 finding categories with the most
* findings.
*/
public final List categoriesWithMostFindings() {
return categoriesWithMostFindings;
}
/**
*
* The date from which the metrics summary information was retrieved.
*
*
* @return The date from which the metrics summary information was retrieved.
*/
public final Instant date() {
return date;
}
/**
*
* The number of open findings of each severity.
*
*
* @return The number of open findings of each severity.
*/
public final FindingMetricsValuePerSeverity openFindings() {
return openFindings;
}
/**
* 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 {@code 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.
*/
public final boolean hasScansWithMostOpenCriticalFindings() {
return scansWithMostOpenCriticalFindings != null && !(scansWithMostOpenCriticalFindings instanceof SdkAutoConstructList);
}
/**
*
* A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open critical
* findings.
*
*
* 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 {@link #hasScansWithMostOpenCriticalFindings}
* method.
*
*
* @return A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open
* critical findings.
*/
public final List scansWithMostOpenCriticalFindings() {
return scansWithMostOpenCriticalFindings;
}
/**
* 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 {@code 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.
*/
public final boolean hasScansWithMostOpenFindings() {
return scansWithMostOpenFindings != null && !(scansWithMostOpenFindings instanceof SdkAutoConstructList);
}
/**
*
* A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open findings.
*
*
* 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 {@link #hasScansWithMostOpenFindings} method.
*
*
* @return A list of ScanNameWithFindingNum
objects for the top 3 scans with the most number of open
* findings.
*/
public final List scansWithMostOpenFindings() {
return scansWithMostOpenFindings;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasCategoriesWithMostFindings() ? categoriesWithMostFindings() : null);
hashCode = 31 * hashCode + Objects.hashCode(date());
hashCode = 31 * hashCode + Objects.hashCode(openFindings());
hashCode = 31 * hashCode
+ Objects.hashCode(hasScansWithMostOpenCriticalFindings() ? scansWithMostOpenCriticalFindings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasScansWithMostOpenFindings() ? scansWithMostOpenFindings() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof MetricsSummary)) {
return false;
}
MetricsSummary other = (MetricsSummary) obj;
return hasCategoriesWithMostFindings() == other.hasCategoriesWithMostFindings()
&& Objects.equals(categoriesWithMostFindings(), other.categoriesWithMostFindings())
&& Objects.equals(date(), other.date()) && Objects.equals(openFindings(), other.openFindings())
&& hasScansWithMostOpenCriticalFindings() == other.hasScansWithMostOpenCriticalFindings()
&& Objects.equals(scansWithMostOpenCriticalFindings(), other.scansWithMostOpenCriticalFindings())
&& hasScansWithMostOpenFindings() == other.hasScansWithMostOpenFindings()
&& Objects.equals(scansWithMostOpenFindings(), other.scansWithMostOpenFindings());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString
.builder("MetricsSummary")
.add("CategoriesWithMostFindings", hasCategoriesWithMostFindings() ? categoriesWithMostFindings() : null)
.add("Date", date())
.add("OpenFindings", openFindings())
.add("ScansWithMostOpenCriticalFindings",
hasScansWithMostOpenCriticalFindings() ? scansWithMostOpenCriticalFindings() : null)
.add("ScansWithMostOpenFindings", hasScansWithMostOpenFindings() ? scansWithMostOpenFindings() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "categoriesWithMostFindings":
return Optional.ofNullable(clazz.cast(categoriesWithMostFindings()));
case "date":
return Optional.ofNullable(clazz.cast(date()));
case "openFindings":
return Optional.ofNullable(clazz.cast(openFindings()));
case "scansWithMostOpenCriticalFindings":
return Optional.ofNullable(clazz.cast(scansWithMostOpenCriticalFindings()));
case "scansWithMostOpenFindings":
return Optional.ofNullable(clazz.cast(scansWithMostOpenFindings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function