codacy-plugins-api
API
Generated with
codacy-plugins-api/com.codacy.plugins.api/com.codacy.plugins.api.results/Pattern

Pattern

com.codacy.plugins.api.results.Pattern
object Pattern

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Pattern.type

Members list

Type members

Classlikes

object Category extends Enumeration

Attributes

Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
Category.type
case class Definition(patternId: Id, parameters: Set[Definition])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Description(patternId: Id, title: Title, description: Option[DescriptionText], timeToFix: Option[TimeToFix], parameters: Set[Description])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class DescriptionText(value: String) extends AnyVal

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
final case class Id(value: String) extends AnyVal

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
object ScanType extends Enumeration

Attributes

Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
ScanType.type
case class Specification(patternId: Id, level: Level, category: Category, subcategory: Option[Subcategory], scanType: Option[ScanType], parameters: Set[Specification], languages: Set[Language], enabled: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Subcategory extends Enumeration

Attributes

Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class TimeToFix(value: Int) extends AnyVal

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all
final case class Title(value: String) extends AnyVal

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all

Types

type Category = Value
type ScanType = Value

ScanType represents the type of analysis performed to discover issues that match the associated patterns.

ScanType represents the type of analysis performed to discover issues that match the associated patterns.

Scan types can be divided into two "categories":

  • Static scan types: these are the only scan types that can actually be associated to a pattern of our static analysis pipeline. These scans are performed on "static" source code.
    • SAST
    • SCA
    • ContainerSCA
    • Secrets
    • IaC
    • CICD
    • License
  • Dynamic scan types: are performed on live applications and can never be associated with patterns of our static analysis pipeline. They are defined here for completion.
    • PenTesting
    • DAST
    • CSPM

Attributes

Generated with