software.amazon.awssdk.services.securityhub.model

Class BatchUpdateFindingsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.securityhub.model.SecurityHubRequest

software.amazon.awssdk.services.securityhub.model.BatchUpdateFindingsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchUpdateFindingsRequest.Builder,BatchUpdateFindingsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchUpdateFindingsRequest
extends SecurityHubRequest
implements ToCopyableBuilder<BatchUpdateFindingsRequest.Builder,BatchUpdateFindingsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchUpdateFindingsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchUpdateFindingsRequest.Builder	builder()
Integer	confidence() The updated value for the finding confidence.
Integer	criticality() The updated value for the level of importance assigned to the resources associated with the findings.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<AwsSecurityFindingIdentifier>	findingIdentifiers() The list of findings to update.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFindingIdentifiers() For responses, this returns true if the service returned a value for the FindingIdentifiers property.
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.
boolean	hasUserDefinedFields() For responses, this returns true if the service returned a value for the UserDefinedFields property.
NoteUpdate	note() Returns the value of the Note property for this object.
List<RelatedFinding>	relatedFindings() A list of findings that are related to the updated findings.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchUpdateFindingsRequest.Builder>	serializableBuilderClass()
SeverityUpdate	severity() Used to update the finding severity.
BatchUpdateFindingsRequest.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.
Map<String,String>	userDefinedFields() A list of name/value string pairs associated with the finding.
VerificationState	verificationState() Indicates the veracity of a finding.
String	verificationStateAsString() Indicates the veracity of a finding.
WorkflowUpdate	workflow() Used to update the workflow status of a finding.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hasFindingIdentifiers

public final boolean hasFindingIdentifiers()

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

findingIdentifiers

public final List<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.

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

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.

note

public final NoteUpdate note()

Returns the value of the Note property for this object.

Returns:

The value of the Note property for this object.

severity

public final SeverityUpdate severity()

Used to update the finding severity.

Returns:

Used to update the finding severity.

verificationState

public final 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

If the service returns an enum value that is not available in the current SDK version, verificationState will return VerificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationStateAsString().

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

verificationStateAsString

public final String verificationStateAsString()

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

If the service returns an enum value that is not available in the current SDK version, verificationState will return VerificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationStateAsString().

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

confidence

public final 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.

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.

criticality

public final 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.

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.

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

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

• Software and Configuration Checks

• TTPs

• Effects

• Unusual Behaviors

• Sensitive Data Identifications

hasUserDefinedFields

public final boolean hasUserDefinedFields()

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

userDefinedFields

public final 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.

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

Returns:

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

workflow

public final WorkflowUpdate workflow()

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.

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

Returns:

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

toBuilder

public BatchUpdateFindingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchUpdateFindingsRequest.Builder,BatchUpdateFindingsRequest>

Specified by:

toBuilder in class SecurityHubRequest

builder

public static BatchUpdateFindingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchUpdateFindingsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo