Class PrevalidationSignal
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PrevalidationSignal.Builder,PrevalidationSignal>
One producer's conclusion about one subject on one scoring dimension.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic PrevalidationSignal.Builderbuilder()final SignalComputationcomputed()The deterministic values the producer computed from its assessment.final StringThe producer's conclusion.final DoubleThe producer's confidence in this conclusion, on its native 0-1 scale.Why the producer is or is not sure, kept structured rather than prose.final SignalDimensionThe axis this signal speaks to.final StringThe axis this signal speaks to.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final SignalExploitabilityWhat validation established about exploitability, on an exploitability signal.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final SignalImpactDimensionsThe three impact dimensions an impact signal assessed, each with the basis the producer had for it.final SignalPreconditionsThe four exploit preconditions a likelihood signal assessed, each with the basis the producer had for it.final StringStable name of the producer that emitted this signal.final StringVersion of that producer.static Class<? extends PrevalidationSignal.Builder> final SignalStrengthThe signal's own rating.final StringThe signal's own rating.final StringWhat this signal is about, such as a finding or issue reference.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
subjectRef
What this signal is about, such as a finding or issue reference.
- Returns:
- What this signal is about, such as a finding or issue reference.
-
dimension
The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
If the service returns an enum value that is not available in the current SDK version,
dimensionwill returnSignalDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdimensionAsString().- Returns:
- The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
- See Also:
-
dimensionAsString
The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
If the service returns an enum value that is not available in the current SDK version,
dimensionwill returnSignalDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdimensionAsString().- Returns:
- The axis this signal speaks to. Absent when the producer reported a dimension with no mapping yet.
- See Also:
-
signalStrength
The signal's own rating. This is an input to scoring and is NOT the finding's severity.
If the service returns an enum value that is not available in the current SDK version,
signalStrengthwill returnSignalStrength.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsignalStrengthAsString().- Returns:
- The signal's own rating. This is an input to scoring and is NOT the finding's severity.
- See Also:
-
signalStrengthAsString
The signal's own rating. This is an input to scoring and is NOT the finding's severity.
If the service returns an enum value that is not available in the current SDK version,
signalStrengthwill returnSignalStrength.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsignalStrengthAsString().- Returns:
- The signal's own rating. This is an input to scoring and is NOT the finding's severity.
- See Also:
-
conclusion
-
producerId
Stable name of the producer that emitted this signal.
- Returns:
- Stable name of the producer that emitted this signal.
-
producerVersion
-
confidence
The producer's confidence in this conclusion, on its native 0-1 scale. Absent when the stored value falls outside 0-1.
- Returns:
- The producer's confidence in this conclusion, on its native 0-1 scale. Absent when the stored value falls outside 0-1.
-
confidenceReasoning
Why the producer is or is not sure, kept structured rather than prose.
- Returns:
- Why the producer is or is not sure, kept structured rather than prose.
-
computed
The deterministic values the producer computed from its assessment.
- Returns:
- The deterministic values the producer computed from its assessment.
-
preconditions
The four exploit preconditions a likelihood signal assessed, each with the basis the producer had for it.
- Returns:
- The four exploit preconditions a likelihood signal assessed, each with the basis the producer had for it.
-
impactDimensions
The three impact dimensions an impact signal assessed, each with the basis the producer had for it. These are what the computed impact band is derived from.
- Returns:
- The three impact dimensions an impact signal assessed, each with the basis the producer had for it. These are what the computed impact band is derived from.
-
exploitability
What validation established about exploitability, on an exploitability signal. This summarizes the verdict the signal was derived from; the proof itself is the VALIDATION_EVIDENCE artifact it cites.
- Returns:
- What validation established about exploitability, on an exploitability signal. This summarizes the verdict the signal was derived from; the proof itself is the VALIDATION_EVIDENCE artifact it cites.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<PrevalidationSignal.Builder,PrevalidationSignal> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-