@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FindingProviderFields extends Object implements Serializable, Cloneable, StructuredPojo
In a
BatchImportFindings
request, finding providers use FindingProviderFields
to provide
and update values for the following fields:
Confidence
Criticality
RelatedFindings
Severity
Types
The preceding fields are nested under the FindingProviderFields
object, but also have analogues of the
same name as top-level ASFF fields. When a new finding is sent to Security Hub by a finding provider, Security Hub
populates the FindingProviderFields
object automatically, if it is empty, based on the corresponding
top-level fields.
Finding providers can update FindingProviderFields
only by using the BatchImportFindings
operation. Finding providers can't update this object with the
BatchUpdateFindings
operation. Customers can update the top-level fields by using the
BatchUpdateFindings
operation. Customers can't update FindingProviderFields
.
For information about how Security Hub handles updates from BatchImportFindings
to
FindingProviderFields
and to the corresponding top-level attributes, see Using FindingProviderFields
in the Security Hub User Guide.
Constructor and Description |
---|
FindingProviderFields() |
Modifier and Type | Method and Description |
---|---|
FindingProviderFields |
clone() |
boolean |
equals(Object obj) |
Integer |
getConfidence()
A finding's confidence.
|
Integer |
getCriticality()
The level of importance assigned to the resources associated with the finding.
|
List<RelatedFinding> |
getRelatedFindings()
A list of findings that are related to the current finding.
|
FindingProviderSeverity |
getSeverity()
The severity of a finding.
|
List<String> |
getTypes()
One or more finding types in the format of
namespace/category/classifier that classify a finding. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setConfidence(Integer confidence)
A finding's confidence.
|
void |
setCriticality(Integer criticality)
The level of importance assigned to the resources associated with the finding.
|
void |
setRelatedFindings(Collection<RelatedFinding> relatedFindings)
A list of findings that are related to the current finding.
|
void |
setSeverity(FindingProviderSeverity severity)
The severity of a finding.
|
void |
setTypes(Collection<String> types)
One or more finding types in the format of
namespace/category/classifier that classify a finding. |
String |
toString()
Returns a string representation of this object.
|
FindingProviderFields |
withConfidence(Integer confidence)
A finding's confidence.
|
FindingProviderFields |
withCriticality(Integer criticality)
The level of importance assigned to the resources associated with the finding.
|
FindingProviderFields |
withRelatedFindings(Collection<RelatedFinding> relatedFindings)
A list of findings that are related to the current finding.
|
FindingProviderFields |
withRelatedFindings(RelatedFinding... relatedFindings)
A list of findings that are related to the current finding.
|
FindingProviderFields |
withSeverity(FindingProviderSeverity severity)
The severity of a finding.
|
FindingProviderFields |
withTypes(Collection<String> types)
One or more finding types in the format of
namespace/category/classifier that classify a finding. |
FindingProviderFields |
withTypes(String... types)
One or more finding types in the format of
namespace/category/classifier that classify a finding. |
public void setConfidence(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.
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.
public Integer getConfidence()
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.
Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
public FindingProviderFields withConfidence(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.
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.
public void setCriticality(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.
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.
public Integer getCriticality()
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.
A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
public FindingProviderFields withCriticality(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.
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.
public List<RelatedFinding> getRelatedFindings()
A list of findings that are related to the current finding.
public void setRelatedFindings(Collection<RelatedFinding> relatedFindings)
A list of findings that are related to the current finding.
relatedFindings
- A list of findings that are related to the current finding.public FindingProviderFields withRelatedFindings(RelatedFinding... relatedFindings)
A list of findings that are related to the current finding.
NOTE: This method appends the values to the existing list (if any). Use
setRelatedFindings(java.util.Collection)
or withRelatedFindings(java.util.Collection)
if you
want to override the existing values.
relatedFindings
- A list of findings that are related to the current finding.public FindingProviderFields withRelatedFindings(Collection<RelatedFinding> relatedFindings)
A list of findings that are related to the current finding.
relatedFindings
- A list of findings that are related to the current finding.public void setSeverity(FindingProviderSeverity severity)
The severity of a finding.
severity
- The severity of a finding.public FindingProviderSeverity getSeverity()
The severity of a finding.
public FindingProviderFields withSeverity(FindingProviderSeverity severity)
The severity of a finding.
severity
- The severity of a finding.public List<String> getTypes()
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
namespace/category/classifier
that classify a
finding.
Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
public void setTypes(Collection<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
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
public FindingProviderFields withTypes(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
NOTE: This method appends the values to the existing list (if any). Use
setTypes(java.util.Collection)
or withTypes(java.util.Collection)
if you want to override the
existing values.
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
public FindingProviderFields withTypes(Collection<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
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
public String toString()
toString
in class Object
Object.toString()
public FindingProviderFields clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.