com.contrastsecurity.sdk.scan

Interface Scan.Definition

Enclosing interface:

Scan

public static interface Scan.Definition

Builder for defining a new scan.

Method Summary

Modifier and Type	Method and Description
Scan	create()
Scan.Definition	withExistingCodeArtifact(CodeArtifact codeArtifact)
Scan.Definition	withExistingCodeArtifact(java.lang.String id)
Scan.Definition	withLabel(java.lang.String label)

Method Detail

withExistingCodeArtifact

Scan.Definition withExistingCodeArtifact(java.lang.String id)

Parameters:

id - ID of the code artifact to scan

Returns:

this

withExistingCodeArtifact

Scan.Definition withExistingCodeArtifact(CodeArtifact codeArtifact)

Parameters:

codeArtifact - the code artifact to scan

Returns:

this

withLabel

Scan.Definition withLabel(java.lang.String label)

Parameters:

label - label that distinguishes this scan from others in the project

Returns:

this

create

Scan create()
     throws java.io.IOException

Returns:

new started scan

Throws:

java.io.IOException - when an IO error occurs while making the request to the Contrast API

UnauthorizedException - when Contrast rejects the credentials used to send the request

ResourceNotFoundException - when the requested resource does not exist

HttpResponseException - when Contrast rejects this request with an error code