Skip to main content

Gcp/containeranalysis

@swamp/gcp/containeranalysisv2026.05.29.1· 4d agoMODELS
01README

Google Cloud containeranalysis infrastructure models

02Release Notes
  • Updated: notes, notes_occurrences, occurrences
03Models3
@swamp/gcp/containeranalysis/notesv2026.05.29.1notes.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
aiSkillAnalysis?objectAISkillAnalysisNote provides the metadata of an AI-based skill analysis.
attestation?objectNote kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences,
build?objectNote holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.
compliance?object
deployment?objectAn artifact that can be deployed in some runtime.
discovery?objectA note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis.
dsseAttestation?object
expirationTime?stringTime of expiration for this note. Empty if note does not expire.
image?objectBasis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url.
longDescription?stringA detailed description of this note.
package?objectPackageNote represents a particular package version.
relatedNoteNames?arrayOther notes related to this note.
relatedUrl?arrayURLs associated with this note.
sbomReference?objectThe note representing an SBOM reference.
secret?objectThe note representing a secret.
shortDescription?stringA one sentence description of this note.
upgrade?objectAn Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update.
vulnerability?objectA security vulnerability that can be found in resources.
vulnerabilityAssessment?objectA single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE.
noteId?stringRequired. The ID to use for this note.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a notes
fn get(identifier: string)
Get a notes
ArgumentTypeDescription
identifierstringThe name of the notes
fn update()
Update notes attributes
fn delete(identifier: string)
Delete the notes
ArgumentTypeDescription
identifierstringThe name of the notes
fn sync()
Sync notes state from GCP
fn list(filter?: string, pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List notes resources
ArgumentTypeDescription
filter?stringThe filter expression.
pageSize?numberNumber of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
returnPartialSuccess?booleanIf set, the request will return all reachable Notes and report all unreachable regions in the `unreachable` field in the response. Only applicable for requests in the global region.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn batch_create(notes?: any)
batch create
ArgumentTypeDescription
notes?any
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— A type of analysis that can be done for a resource.
@swamp/gcp/containeranalysis/notes-occurrencesv2026.05.29.1notes_occurrences.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
fn get(identifier: string)
Get a occurrences
ArgumentTypeDescription
identifierstringThe name of the occurrences
fn sync()
Sync occurrences state from GCP
fn list(filter?: string, pageSize?: number, maxPages?: number)
List occurrences resources
ArgumentTypeDescription
filter?stringThe filter expression.
pageSize?numberNumber of occurrences to return in the list.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— An instance of an analysis type that has been found on a resource.
@swamp/gcp/containeranalysis/occurrencesv2026.05.29.1occurrences.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
advisoryPublishTime?stringThe time this advisory was published by the source.
aiSkillAnalysis?objectAISkillAnalysisOccurrence provides the results of an AI-based skill analysis.
attestationobject
build?objectDetails of a build occurrence.
compliance?objectAn indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason.
deployment?objectThe period during which some deployable was active in a runtime.
discovery?objectProvides information about the analysis status of a discovered resource.
dsseAttestation?objectDeprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence.
envelope?objectMUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type.
image?objectDetails of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM.
noteName?stringRequired. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests.
package?objectDetails on how a particular software package was installed on a system.
remediation?stringA description of actions that can be taken to remedy the note.
resourceUri?stringRequired. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image.
sbomReference?objectThe occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details.
secret?objectThe occurrence provides details of a secret.
upgrade?objectAn Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update.
vulnerability?objectAn occurrence of a severity vulnerability on a resource.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
fn create()
Create a occurrences
fn get(identifier: string)
Get a occurrences
ArgumentTypeDescription
identifierstringThe name of the occurrences
fn update()
Update occurrences attributes
fn delete(identifier: string)
Delete the occurrences
ArgumentTypeDescription
identifierstringThe name of the occurrences
fn sync()
Sync occurrences state from GCP
fn list(filter?: string, pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List occurrences resources
ArgumentTypeDescription
filter?stringThe filter expression.
pageSize?numberNumber of occurrences to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
returnPartialSuccess?booleanIf set, the request will return all reachable Occurrences and report all unreachable regions in the `unreachable` field in the response. Only applicable for requests in the global region.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn batch_create(occurrences?: any)
batch create
ArgumentTypeDescription
occurrences?any
fn get_iam_policy(options?: any)
get iam policy
ArgumentTypeDescription
options?any
fn get_notes()
get notes
fn get_vulnerability_summary()
get vulnerability summary
fn set_iam_policy(policy?: any)
set iam policy
ArgumentTypeDescription
policy?any
fn test_iam_permissions(permissions?: any)
test iam permissions
ArgumentTypeDescription
permissions?any

Resources

state(infinite)— An instance of an analysis type that has been found on a resource.
04Previous Versions19
2026.05.27.2May 28, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.05.27.1May 27, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.05.26.1May 26, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.05.25.1May 25, 2026
  • Updated: notes, notes_occurrences, occurrences

Modified 3 models

2026.05.24.1May 24, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.05.21.2May 21, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.05.21.1May 21, 2026

Modified 2 models

2026.05.20.1May 20, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.09.1May 10, 2026
  • Updated: notes_occurrences, occurrences
2026.05.02.1May 2, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.04.23.1Apr 23, 2026
2026.04.04.1Apr 4, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.04.03.3Apr 3, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.04.03.1Apr 3, 2026
  • Updated: notes, notes_occurrences, occurrences
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
  • Added: notes, notes_occurrences, occurrences
05Stats
A
100 / 100
Downloads
0
Archive size
153.3 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels