com.amazonaws.services.securityhub.model

Class BatchUpdateFindingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.securityhub.model.BatchUpdateFindingsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BatchUpdateFindingsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchUpdateFindingsRequest()

Method Summary

Modifier and Type	Method and Description
BatchUpdateFindingsRequest	addUserDefinedFieldsEntry(String key, String value) Add a single UserDefinedFields entry
BatchUpdateFindingsRequest	clearUserDefinedFieldsEntries() Removes all the entries added into UserDefinedFields.
BatchUpdateFindingsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Integer	getConfidence() The updated value for the finding confidence.
Integer	getCriticality() The updated value for the level of importance assigned to the resources associated with the findings.
List<AwsSecurityFindingIdentifier>	getFindingIdentifiers() The list of findings to update.
NoteUpdate	getNote()
List<RelatedFinding>	getRelatedFindings() A list of findings that are related to the updated findings.
SeverityUpdate	getSeverity() Used to update the finding severity.
List<String>	getTypes() One or more finding types in the format of namespace/category/classifier that classify a finding.
Map<String,String>	getUserDefinedFields() A list of name/value string pairs associated with the finding.
String	getVerificationState() Indicates the veracity of a finding.
WorkflowUpdate	getWorkflow() Used to update the workflow status of a finding.
int	hashCode()
void	setConfidence(Integer confidence) The updated value for the finding confidence.
void	setCriticality(Integer criticality) The updated value for the level of importance assigned to the resources associated with the findings.
void	setFindingIdentifiers(Collection<AwsSecurityFindingIdentifier> findingIdentifiers) The list of findings to update.
void	setNote(NoteUpdate note)
void	setRelatedFindings(Collection<RelatedFinding> relatedFindings) A list of findings that are related to the updated findings.
void	setSeverity(SeverityUpdate severity) Used to update the finding severity.
void	setTypes(Collection<String> types) One or more finding types in the format of namespace/category/classifier that classify a finding.
void	setUserDefinedFields(Map<String,String> userDefinedFields) A list of name/value string pairs associated with the finding.
void	setVerificationState(String verificationState) Indicates the veracity of a finding.
void	setWorkflow(WorkflowUpdate workflow) Used to update the workflow status of a finding.
String	toString() Returns a string representation of this object.
BatchUpdateFindingsRequest	withConfidence(Integer confidence) The updated value for the finding confidence.
BatchUpdateFindingsRequest	withCriticality(Integer criticality) The updated value for the level of importance assigned to the resources associated with the findings.
BatchUpdateFindingsRequest	withFindingIdentifiers(AwsSecurityFindingIdentifier... findingIdentifiers) The list of findings to update.
BatchUpdateFindingsRequest	withFindingIdentifiers(Collection<AwsSecurityFindingIdentifier> findingIdentifiers) The list of findings to update.
BatchUpdateFindingsRequest	withNote(NoteUpdate note)
BatchUpdateFindingsRequest	withRelatedFindings(Collection<RelatedFinding> relatedFindings) A list of findings that are related to the updated findings.
BatchUpdateFindingsRequest	withRelatedFindings(RelatedFinding... relatedFindings) A list of findings that are related to the updated findings.
BatchUpdateFindingsRequest	withSeverity(SeverityUpdate severity) Used to update the finding severity.
BatchUpdateFindingsRequest	withTypes(Collection<String> types) One or more finding types in the format of namespace/category/classifier that classify a finding.
BatchUpdateFindingsRequest	withTypes(String... types) One or more finding types in the format of namespace/category/classifier that classify a finding.
BatchUpdateFindingsRequest	withUserDefinedFields(Map<String,String> userDefinedFields) A list of name/value string pairs associated with the finding.
BatchUpdateFindingsRequest	withVerificationState(String verificationState) Indicates the veracity of a finding.
BatchUpdateFindingsRequest	withVerificationState(VerificationState verificationState) Indicates the veracity of a finding.
BatchUpdateFindingsRequest	withWorkflow(WorkflowUpdate workflow) Used to update the workflow status of a finding.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchUpdateFindingsRequest

public BatchUpdateFindingsRequest()

Method Detail

getFindingIdentifiers

public List<AwsSecurityFindingIdentifier> getFindingIdentifiers()

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

Returns:

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

setFindingIdentifiers

public void setFindingIdentifiers(Collection<AwsSecurityFindingIdentifier> findingIdentifiers)

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

Parameters:

findingIdentifiers - The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

withFindingIdentifiers

public BatchUpdateFindingsRequest withFindingIdentifiers(AwsSecurityFindingIdentifier... findingIdentifiers)

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

NOTE: This method appends the values to the existing list (if any). Use setFindingIdentifiers(java.util.Collection) or withFindingIdentifiers(java.util.Collection) if you want to override the existing values.

Parameters:

findingIdentifiers - The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFindingIdentifiers

public BatchUpdateFindingsRequest withFindingIdentifiers(Collection<AwsSecurityFindingIdentifier> findingIdentifiers)

The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

Parameters:

findingIdentifiers - The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.

For each finding, the list provides the finding identifier and the ARN of the finding provider.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNote

public void setNote(NoteUpdate note)

Parameters:

note -

getNote

public NoteUpdate getNote()

Returns:

withNote

public BatchUpdateFindingsRequest withNote(NoteUpdate note)

Parameters:

note -

Returns:

Returns a reference to this object so that method calls can be chained together.

setSeverity

public void setSeverity(SeverityUpdate severity)

Used to update the finding severity.

Parameters:

severity - Used to update the finding severity.

getSeverity

public SeverityUpdate getSeverity()

Used to update the finding severity.

Returns:

Used to update the finding severity.

withSeverity

public BatchUpdateFindingsRequest withSeverity(SeverityUpdate severity)

Used to update the finding severity.

Parameters:

severity - Used to update the finding severity.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVerificationState

public void setVerificationState(String verificationState)

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Parameters:

verificationState - Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

See Also:

VerificationState

getVerificationState

public String getVerificationState()

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Returns:

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

See Also:

VerificationState

withVerificationState

public BatchUpdateFindingsRequest withVerificationState(String verificationState)

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Parameters:

verificationState - Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerificationState

withVerificationState

public BatchUpdateFindingsRequest withVerificationState(VerificationState verificationState)

Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Parameters:

verificationState - Indicates the veracity of a finding.

The available values for VerificationState are as follows.

• UNKNOWN – The default disposition of a security finding

• TRUE_POSITIVE – The security finding is confirmed

• FALSE_POSITIVE – The security finding was determined to be a false alarm

• BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerificationState

setConfidence

public void setConfidence(Integer confidence)

The updated value for the finding 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.

Parameters:

confidence - The updated value for the finding 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.

getConfidence

public Integer getConfidence()

The updated value for the finding 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:

The updated value for the finding 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.

withConfidence

public BatchUpdateFindingsRequest withConfidence(Integer confidence)

The updated value for the finding 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.

Parameters:

confidence - The updated value for the finding 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:

Returns a reference to this object so that method calls can be chained together.

setCriticality

public void setCriticality(Integer criticality)

The updated value for the level of importance assigned to the resources associated with the findings.

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

Parameters:

criticality - The updated value for the level of importance assigned to the resources associated with the findings.

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

getCriticality

public Integer getCriticality()

The updated value for the level of importance assigned to the resources associated with the findings.

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 updated value for the level of importance assigned to the resources associated with the findings.

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

withCriticality

public BatchUpdateFindingsRequest withCriticality(Integer criticality)

The updated value for the level of importance assigned to the resources associated with the findings.

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

Parameters:

criticality - The updated value for the level of importance assigned to the resources associated with the findings.

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:

Returns a reference to this object so that method calls can be chained together.

getTypes

public List<String> getTypes()

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

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

Returns:

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

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

setTypes

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 as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

Parameters:

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

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

withTypes

public BatchUpdateFindingsRequest withTypes(String... types)

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

Valid namespace values are as follows.

• 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.

Parameters:

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

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

Returns:

Returns a reference to this object so that method calls can be chained together.

withTypes

public BatchUpdateFindingsRequest withTypes(Collection<String> types)

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

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

Parameters:

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

Valid namespace values are as follows.

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserDefinedFields

public Map<String,String> getUserDefinedFields()

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Returns:

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

setUserDefinedFields

public void setUserDefinedFields(Map<String,String> userDefinedFields)

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Parameters:

userDefinedFields - A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

withUserDefinedFields

public BatchUpdateFindingsRequest withUserDefinedFields(Map<String,String> userDefinedFields)

A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Parameters:

userDefinedFields - A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

Returns:

Returns a reference to this object so that method calls can be chained together.

addUserDefinedFieldsEntry

public BatchUpdateFindingsRequest addUserDefinedFieldsEntry(String key,
                                                            String value)

Add a single UserDefinedFields entry

See Also:

withUserDefinedFields(java.util.Map<java.lang.String, java.lang.String>)

clearUserDefinedFieldsEntries

public BatchUpdateFindingsRequest clearUserDefinedFieldsEntries()

Removes all the entries added into UserDefinedFields.

Returns:

Returns a reference to this object so that method calls can be chained together.

setWorkflow

public void setWorkflow(WorkflowUpdate workflow)

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Parameters:

workflow - Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

getWorkflow

public WorkflowUpdate getWorkflow()

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Returns:

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

withWorkflow

public BatchUpdateFindingsRequest withWorkflow(WorkflowUpdate workflow)

Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Parameters:

workflow - Used to update the workflow status of a finding.

The workflow status indicates the progress of the investigation into the finding.

Returns:

Returns a reference to this object so that method calls can be chained together.

getRelatedFindings

public List<RelatedFinding> getRelatedFindings()

A list of findings that are related to the updated findings.

Returns:

A list of findings that are related to the updated findings.

setRelatedFindings

public void setRelatedFindings(Collection<RelatedFinding> relatedFindings)

A list of findings that are related to the updated findings.

Parameters:

relatedFindings - A list of findings that are related to the updated findings.

withRelatedFindings

public BatchUpdateFindingsRequest withRelatedFindings(RelatedFinding... relatedFindings)

A list of findings that are related to the updated findings.

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.

Parameters:

relatedFindings - A list of findings that are related to the updated findings.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRelatedFindings

public BatchUpdateFindingsRequest withRelatedFindings(Collection<RelatedFinding> relatedFindings)

A list of findings that are related to the updated findings.

Parameters:

relatedFindings - A list of findings that are related to the updated 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 BatchUpdateFindingsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()