Package software.amazon.awssdk.services.inspectorscan.model

Class ScanSbomRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.inspectorscan.model.InspectorScanRequest

software.amazon.awssdk.services.inspectorscan.model.ScanSbomRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ScanSbomRequest.Builder,ScanSbomRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ScanSbomRequest
extends InspectorScanRequest
implements ToCopyableBuilder<ScanSbomRequest.Builder,ScanSbomRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScanSbomRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ScanSbomRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
OutputFormat	outputFormat()	The output format for the vulnerability report.
String	outputFormatAsString()	The output format for the vulnerability report.
Document	sbom()	The JSON file for the SBOM you want to scan.
List<SdkField<?>>	sdkFields()
static Class<? extends ScanSbomRequest.Builder>	serializableBuilderClass()
ScanSbomRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

sbom

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

public final OutputFormat 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 return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

Returns:

The output format for the vulnerability report.

See Also:

OutputFormat

outputFormatAsString

public final String 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 return OutputFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputFormatAsString().

Returns:

The output format for the vulnerability report.

See Also:

OutputFormat

toBuilder

public ScanSbomRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScanSbomRequest.Builder,ScanSbomRequest>

Specified by:

toBuilder in class InspectorScanRequest

builder

public static ScanSbomRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ScanSbomRequest.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