Package software.amazon.awssdk.services.codegurusecurity.model

Class GetScanResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.codegurusecurity.model.CodeGuruSecurityResponse

software.amazon.awssdk.services.codegurusecurity.model.GetScanResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetScanResponse.Builder,GetScanResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetScanResponse.Builder

Method Summary

Modifier and Type	Method	Description
AnalysisType	analysisType()	The type of analysis CodeGuru Security performed in the scan, either Security or All.
String	analysisTypeAsString()	The type of analysis CodeGuru Security performed in the scan, either Security or All.
static GetScanResponse.Builder	builder()
Instant	createdAt()	The time the scan was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	numberOfRevisions()	The number of times a scan has been re-run on a revised resource.
String	runId()	UUID that identifies the individual scan run.
String	scanName()	The name of the scan.
String	scanNameArn()	The ARN for the scan name.
ScanState	scanState()	The current state of the scan.
String	scanStateAsString()	The current state of the scan.
List<SdkField<?>>	sdkFields()
static Class<? extends GetScanResponse.Builder>	serializableBuilderClass()
GetScanResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The time when the scan was last updated.

Methods inherited from class software.amazon.awssdk.services.codegurusecurity.model.CodeGuruSecurityResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

analysisType

public final AnalysisType analysisType()

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

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

Returns:

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

See Also:

AnalysisType

analysisTypeAsString

public final String analysisTypeAsString()

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

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

Returns:

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

See Also:

AnalysisType

createdAt

public final Instant createdAt()

The time the scan was created.

Returns:

The time the scan was created.

numberOfRevisions

public final Long numberOfRevisions()

The number of times a scan has been re-run on a revised resource.

Returns:

The number of times a scan has been re-run on a revised resource.

runId

public final String runId()

UUID that identifies the individual scan run.

Returns:

UUID that identifies the individual scan run.

scanName

public final String scanName()

The name of the scan.

Returns:

The name of the scan.

scanNameArn

public final String scanNameArn()

The ARN for the scan name.

Returns:

The ARN for the scan name.

scanState

public final ScanState scanState()

The current state of the scan. Pass either InProgress, Successful, or Failed.

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

Returns:

The current state of the scan. Pass either InProgress, Successful, or Failed.

See Also:

ScanState

scanStateAsString

public final String scanStateAsString()

The current state of the scan. Pass either InProgress, Successful, or Failed.

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

Returns:

The current state of the scan. Pass either InProgress, Successful, or Failed.

See Also:

ScanState

updatedAt

public final Instant updatedAt()

The time when the scan was last updated. Only available for STANDARD scan types.

Returns:

The time when the scan was last updated. Only available for STANDARD scan types.

toBuilder

public GetScanResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetScanResponse.Builder,GetScanResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetScanResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo