software.amazon.awssdk.services.securityhub.model

Class FindingProviderFields

java.lang.Object

software.amazon.awssdk.services.securityhub.model.FindingProviderFields

All Implemented Interfaces:

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

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

In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update values for confidence, criticality, related findings, severity, and types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FindingProviderFields.Builder

Method Summary

Modifier and Type	Method and Description
static FindingProviderFields.Builder	builder()
Integer	confidence() A finding's confidence.
Integer	criticality() The level of importance assigned to the resources associated with the finding.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRelatedFindings() For responses, this returns true if the service returned a value for the RelatedFindings property.
boolean	hasTypes() For responses, this returns true if the service returned a value for the Types property.
List<RelatedFinding>	relatedFindings() A list of findings that are related to the current finding.
List<SdkField<?>>	sdkFields()
static Class<? extends FindingProviderFields.Builder>	serializableBuilderClass()
FindingProviderSeverity	severity() The severity of a finding.
FindingProviderFields.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	types() One or more finding types in the format of namespace/category/classifier that classify a finding.

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

confidence

public final Integer confidence()

A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

Returns:

A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

criticality

public final Integer criticality()

The level of importance assigned to the resources associated with the finding.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

Returns:

The level of importance assigned to the resources associated with the finding.

A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

hasRelatedFindings

public final boolean hasRelatedFindings()

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

relatedFindings

public final List<RelatedFinding> relatedFindings()

A list of findings that are related to the current finding.

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

Returns:

A list of findings that are related to the current finding.

severity

public final FindingProviderSeverity severity()

The severity of a finding.

Returns:

The severity of a finding.

hasTypes

public final boolean hasTypes()

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

types

public final List<String> types()

One or more finding types in the format of namespace/category/classifier that classify a finding.

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

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

Returns:

One or more finding types in the format of namespace/category/classifier that classify a finding.

Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

toBuilder

public FindingProviderFields.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FindingProviderFields.Builder,FindingProviderFields>

builder

public static FindingProviderFields.Builder builder()

serializableBuilderClass

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