MatchingLicense

data class MatchingLicense(val licenseId: String? = null, val licenseUrl: String? = null, val normalizedUrl: String? = null, val matchType: LicenseMatchType? = null, val confidence: Double? = null, val spdxId: String? = null, val matchedName: String? = null, val matchedCatalogUrl: String? = null, val matchedSource: String? = null, val notes: String? = null, val regionalId: String? = null)(source)

One catalog license that matched a submitted URL.

Constructors

Link copied to clipboard
constructor(licenseId: String? = null, licenseUrl: String? = null, normalizedUrl: String? = null, matchType: LicenseMatchType? = null, confidence: Double? = null, spdxId: String? = null, matchedName: String? = null, matchedCatalogUrl: String? = null, matchedSource: String? = null, notes: String? = null, regionalId: String? = null)

Properties

Link copied to clipboard

Match confidence from 0.0 to 1.0.

Link copied to clipboard
@SerialName(value = "license_id")
val licenseId: String?

Catalog license id, often an SPDX id.

Link copied to clipboard
@SerialName(value = "license_url")
val licenseUrl: String?

License URL submitted for matching.

Link copied to clipboard
@SerialName(value = "matched_catalog_url")
val matchedCatalogUrl: String?

Canonical catalog URL for the matched license.

Link copied to clipboard
@SerialName(value = "matched_name")
val matchedName: String?

User-facing name of the matched license.

Link copied to clipboard
@SerialName(value = "matched_source")
val matchedSource: String?

Source that produced the match.

Link copied to clipboard
@SerialName(value = "match_type")
val matchType: LicenseMatchType?

How the catalog matched the URL.

Link copied to clipboard
@SerialName(value = "normalized_url")
val normalizedUrl: String?

Normalized form of licenseUrl.

Link copied to clipboard

Matcher notes such as version normalization or a detected locale.

Link copied to clipboard
@SerialName(value = "regional_id")
val regionalId: String?

Regional or jurisdictional variant id.

Link copied to clipboard
@SerialName(value = "spdx_id")
val spdxId: String?

SPDX identifier when the match resolved to one.