com.amazonaws.services.codegurusecurity.model

Class CreateScanRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codegurusecurity.model.CreateScanRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateScanRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateScanRequest()

Method Summary

Modifier and Type	Method and Description
CreateScanRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateScanRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateScanRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAnalysisType() The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.
String	getClientToken() The idempotency token for the request.
ResourceId	getResourceId() The identifier for the resource object to be scanned.
String	getScanName() The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource.
String	getScanType() The type of scan, either Standard or Express.
Map<String,String>	getTags() An array of key-value pairs used to tag a scan.
int	hashCode()
void	setAnalysisType(String analysisType) The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.
void	setClientToken(String clientToken) The idempotency token for the request.
void	setResourceId(ResourceId resourceId) The identifier for the resource object to be scanned.
void	setScanName(String scanName) The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource.
void	setScanType(String scanType) The type of scan, either Standard or Express.
void	setTags(Map<String,String> tags) An array of key-value pairs used to tag a scan.
String	toString() Returns a string representation of this object.
CreateScanRequest	withAnalysisType(AnalysisType analysisType) The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.
CreateScanRequest	withAnalysisType(String analysisType) The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.
CreateScanRequest	withClientToken(String clientToken) The idempotency token for the request.
CreateScanRequest	withResourceId(ResourceId resourceId) The identifier for the resource object to be scanned.
CreateScanRequest	withScanName(String scanName) The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource.
CreateScanRequest	withScanType(ScanType scanType) The type of scan, either Standard or Express.
CreateScanRequest	withScanType(String scanType) The type of scan, either Standard or Express.
CreateScanRequest	withTags(Map<String,String> tags) An array of key-value pairs used to tag a scan.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateScanRequest

public CreateScanRequest()

Method Detail

setAnalysisType

public void setAnalysisType(String 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.

Parameters:

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.

See Also:

AnalysisType

getAnalysisType

public String getAnalysisType()

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.

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

withAnalysisType

public CreateScanRequest withAnalysisType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalysisType

withAnalysisType

public CreateScanRequest withAnalysisType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AnalysisType

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateScanRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setResourceId

public void setResourceId(ResourceId resourceId)

The identifier for the resource object to be scanned.

Parameters:

resourceId - The identifier for the resource object to be scanned.

getResourceId

public ResourceId getResourceId()

The identifier for the resource object to be scanned.

Returns:

The identifier for the resource object to be scanned.

withResourceId

public CreateScanRequest withResourceId(ResourceId resourceId)

The identifier for the resource object to be scanned.

Parameters:

resourceId - The identifier for the resource object to be scanned.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScanName

public void setScanName(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.

Parameters:

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.

getScanName

public String getScanName()

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

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.

withScanName

public CreateScanRequest withScanName(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScanType

public void setScanType(String 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.

Parameters:

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.

See Also:

ScanType

getScanType

public String getScanType()

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.

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

withScanType

public CreateScanRequest withScanType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScanType

withScanType

public CreateScanRequest withScanType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScanType

getTags

public Map<String,String> getTags()

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.

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.

setTags

public void setTags(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.

Parameters:

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.

withTags

public CreateScanRequest withTags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateScanRequest addTagsEntry(String key,
                                      String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateScanRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateScanRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()