Gcp/containeranalysis
@swamp/gcp/containeranalysisv2026.10.29.1
01README
Google Cloud containeranalysis infrastructure models
02Release Notes
- Updated: notes_occurrences, occurrences
03Behaviors
@swamp/gcp/containeranalysis/notesv2026.10.23.1notes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| aiSkillAnalysis? | object | A note describing an AI skill analysis. |
| attestation? | object | A note describing an attestation role. |
| build? | object | A note describing build provenance for a verifiable build. |
| compliance? | object | A note describing a compliance check. |
| deployment? | object | A note describing something that can be deployed. |
| discovery? | object | A note describing the initial analysis of a resource. |
| dsseAttestation? | object | A note describing a dsse attestation note. |
| expirationTime? | string | Time of expiration for this note. Empty if note does not expire. |
| image? | object | A note describing a base image. |
| longDescription? | string | A detailed description of this note. |
| package? | object | A note describing a package hosted by various package managers. |
| relatedNoteNames? | array | Other notes related to this note. |
| relatedUrl? | array | URLs associated with this note. |
| sbomReference? | object | A note describing an SBOM reference. |
| secret? | object | A note describing a secret. |
| shortDescription? | string | A one sentence description of this note. |
| upgrade? | object | A note describing available package upgrades. |
| vulnerability? | object | A note describing a package vulnerability. |
| vulnerabilityAssessment? | object | A note describing a vulnerability assessment. |
| noteId? | string | Required. The ID to use for this note. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a notes
fn get(identifier: string)
Get a notes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notes |
fn update(identifier?: string)
Update notes attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific notes by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the notes
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the notes |
fn sync(identifier?: string)
Sync notes state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific notes by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List notes resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | The filter expression. |
| pageSize? | number | Number 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? | boolean | If 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? | number | Maximum number of pages to fetch (default: 10) |
fn batch_create(notes?: any)
batch create
| Argument | Type | Description |
|---|---|---|
| notes? | any |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— A type of analysis that can be done for a resource.
@swamp/gcp/containeranalysis/notes-occurrencesv2026.10.29.1notes_occurrences.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name | string | Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. |
fn get(identifier: string)
Get a occurrences
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the occurrences |
fn sync(identifier?: string)
Sync occurrences state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific occurrences by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List occurrences resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | The filter expression. |
| pageSize? | number | Number of occurrences to return in the list. |
| maxPages? | number | Maximum 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.10.29.1occurrences.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| advisoryPublishTime? | string | The time this advisory was published by the source. |
| aiSkillAnalysis? | object | Describes an AI skill analysis. |
| attestation? | object | Describes an attestation of an artifact. |
| build? | object | Describes a verifiable build. |
| compliance? | object | Describes a compliance violation on a linked resource. |
| deployment? | object | Describes the deployment of an artifact on a runtime. |
| discovery? | object | Describes when a resource was discovered. |
| dsseAttestation? | object | Describes an attestation of an artifact using dsse. |
| envelope? | object | https://github.com/secure-systems-lab/dsse |
| image? | object | Describes how this resource derives from the basis in the associated note. |
| noteName? | string | Required. 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? | object | Describes the installation of a package on the linked resource. |
| remediation? | string | A description of actions that can be taken to remedy the note. |
| resourceUri? | string | Required. 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? | object | Describes a specific SBOM reference occurrences. |
| secret? | object | Describes a secret. |
| upgrade? | object | Describes an available package upgrade on the linked resource. |
| vulnerability? | object | Describes a security vulnerability. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a occurrences
fn get(identifier: string)
Get a occurrences
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the occurrences |
fn update(identifier?: string)
Update occurrences attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific occurrences by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the occurrences
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the occurrences |
fn sync(identifier?: string)
Sync occurrences state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific occurrences by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, returnPartialSuccess?: boolean, maxPages?: number)
List occurrences resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | The filter expression. |
| pageSize? | number | Number 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? | boolean | If 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? | number | Maximum number of pages to fetch (default: 10) |
fn batch_create(occurrences?: any)
batch create
| Argument | Type | Description |
|---|---|---|
| occurrences? | any |
fn get_iam_policy(options?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options? | any |
fn get_notes()
get notes
fn get_vulnerability_summary(filter?: any, returnPartialSuccess?: any)
get vulnerability summary
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| returnPartialSuccess? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— An instance of an analysis type that has been found on a resource.
04Previous Versions
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: notes, notes_occurrences, occurrences
2026.10.13.1
- Updated: notes, notes_occurrences, occurrences
2026.09.07.1
- Updated: occurrences
2026.09.03.1
- Updated: notes_occurrences, occurrences
2026.08.28.1
- Updated: notes_occurrences, occurrences
2026.08.18.1
- Updated: notes, occurrences
2026.08.14.1
- Updated: notes_occurrences, occurrences
2026.08.12.2
- Updated: notes, notes_occurrences, occurrences
2026.07.29.1
- Updated: notes, notes_occurrences, occurrences
2026.07.21.4
- Updated: notes, notes_occurrences, occurrences
2026.07.21.1
- Updated: notes, occurrences
2026.07.20.2
- Updated: notes, notes_occurrences, occurrences
2026.07.20.1
- Updated: notes, notes_occurrences, occurrences
2026.07.19.2
- Updated: notes_occurrences
2026.07.19.1
- Updated: notes, notes_occurrences, occurrences
2026.07.18.2
- Updated: notes, notes_occurrences, occurrences
2026.07.17.2
- Updated: notes, occurrences
2026.07.17.1
- Updated: notes, occurrences
2026.07.13.1
- Updated: occurrences
05Stats
A
100 / 100
Downloads
36
Archive size
136.1 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 types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels