Class ScanSbomRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ScanSbomRequest.Builder,
ScanSbomRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ScanSbomRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final OutputFormat
The output format for the vulnerability report.final String
The output format for the vulnerability report.final Document
sbom()
The JSON file for the SBOM you want to scan.static Class
<? extends ScanSbomRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sbom
The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format.
- Returns:
- The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format.
-
outputFormat
The output format for the vulnerability report.
If the service returns an enum value that is not available in the current SDK version,
outputFormat
will returnOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputFormatAsString()
.- Returns:
- The output format for the vulnerability report.
- See Also:
-
outputFormatAsString
The output format for the vulnerability report.
If the service returns an enum value that is not available in the current SDK version,
outputFormat
will returnOutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputFormatAsString()
.- Returns:
- The output format for the vulnerability report.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ScanSbomRequest.Builder,
ScanSbomRequest> - Specified by:
toBuilder
in classInspectorScanRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-