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

Class CreateScanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codegurusecurity.model.CodeGuruSecurityRequest

software.amazon.awssdk.services.codegurusecurity.model.CreateScanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScanRequest.Builder,CreateScanRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateScanRequest.Builder

Method Summary

Modifier and Type	Method	Description
AnalysisType	analysisType()	The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.
String	analysisTypeAsString()	The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.
static CreateScanRequest.Builder	builder()
String	clientToken()	The idempotency token for the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
ResourceId	resourceId()	The identifier for an input resource used to create a scan.
String	scanName()	The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource.
ScanType	scanType()	The type of scan, either Standard or Express.
String	scanTypeAsString()	The type of scan, either Standard or Express.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScanRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	An array of key-value pairs used to tag a scan.
CreateScanRequest.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

analysisType

public final AnalysisType analysisType()

The type of analysis you want CodeGuru Security to perform 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. Defaults to Security type if missing.

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 you want CodeGuru Security to perform 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. Defaults to Security type if missing.

See Also:

AnalysisType

analysisTypeAsString

public final String analysisTypeAsString()

The type of analysis you want CodeGuru Security to perform 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. Defaults to Security type if missing.

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 you want CodeGuru Security to perform 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. Defaults to Security type if missing.

See Also:

AnalysisType

clientToken

public final String clientToken()

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

Returns:

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

resourceId

public final ResourceId resourceId()

The identifier for an input resource used to create a scan.

Returns:

The identifier for an input resource used to create a scan.

scanName

public final String scanName()

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type. If not specified, it will be auto generated.

Returns:

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type. If not specified, it will be auto generated.

scanType

public final ScanType scanType()

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

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

Returns:

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

See Also:

ScanType

scanTypeAsString

public final String scanTypeAsString()

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

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

Returns:

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

See Also:

ScanType

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

• A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

• An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

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

Returns:

An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

• A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

• An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

toBuilder

public CreateScanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScanRequest.Builder,CreateScanRequest>

Specified by:

toBuilder in class CodeGuruSecurityRequest

builder

public static CreateScanRequest.Builder builder()

serializableBuilderClass

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