Updates the specified occurrence.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: containeranalysis1 --scope <scope> projects occurrences-patch ...

Required Scalar Argument

  • <name> (string)
    • Required. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Occurrence:
  attestation:
    serialized-payload: string
  build:
    in-toto-slsa-provenance-v1:
      -type: string
      predicate:
        build-definition:
          build-type: string
        run-details:
          builder:
            id: string
            version: { string: string }
          metadata:
            finished-on: string
            invocation-id: string
            started-on: string
      predicate-type: string
    intoto-provenance:
      builder-config:
        id: string
      materials: [string]
      metadata:
        build-finished-on: string
        build-invocation-id: string
        build-started-on: string
        completeness:
          arguments: boolean
          environment: boolean
          materials: boolean
        reproducible: boolean
      recipe:
        defined-in-material: string
        entry-point: string
        type: string
    intoto-statement:
      -type: string
      predicate-type: string
      provenance:
        builder-config:
          id: string
        materials: [string]
        metadata:
          build-finished-on: string
          build-invocation-id: string
          build-started-on: string
          completeness:
            arguments: boolean
            environment: boolean
            materials: boolean
          reproducible: boolean
        recipe:
          defined-in-material: string
          entry-point: string
          type: string
      slsa-provenance:
        builder:
          id: string
        metadata:
          build-finished-on: string
          build-invocation-id: string
          build-started-on: string
          completeness:
            arguments: boolean
            environment: boolean
            materials: boolean
          reproducible: boolean
        recipe:
          defined-in-material: string
          entry-point: string
          type: string
      slsa-provenance-zero-two:
        build-type: string
        builder:
          id: string
        invocation:
          config-source:
            digest: { string: string }
            entry-point: string
            uri: string
        metadata:
          build-finished-on: string
          build-invocation-id: string
          build-started-on: string
          completeness:
            environment: boolean
            materials: boolean
            parameters: boolean
          reproducible: boolean
    provenance:
      build-options: { string: string }
      builder-version: string
      create-time: string
      creator: string
      end-time: string
      id: string
      logs-uri: string
      project-id: string
      source-provenance:
        artifact-storage-source-uri: string
        context:
          cloud-repo:
            alias-context:
              kind: string
              name: string
            repo-id:
              project-repo-id:
                project-id: string
                repo-name: string
              uid: string
            revision-id: string
          gerrit:
            alias-context:
              kind: string
              name: string
            gerrit-project: string
            host-uri: string
            revision-id: string
          git:
            revision-id: string
            url: string
          labels: { string: string }
      start-time: string
      trigger-id: string
    provenance-bytes: string
  compliance:
    non-compliance-reason: string
  create-time: string
  deployment:
    address: string
    config: string
    deploy-time: string
    platform: string
    resource-uri: [string]
    undeploy-time: string
    user-email: string
  discovery:
    analysis-completed:
      analysis-type: [string]
    analysis-status: string
    analysis-status-error:
      code: integer
      message: string
    archive-time: string
    continuous-analysis: string
    cpe: string
    last-scan-time: string
    sbom-status:
      error: string
      sbom-state: string
  dsse-attestation:
    envelope:
      payload: string
      payload-type: string
    statement:
      -type: string
      predicate-type: string
      provenance:
        builder-config:
          id: string
        materials: [string]
        metadata:
          build-finished-on: string
          build-invocation-id: string
          build-started-on: string
          completeness:
            arguments: boolean
            environment: boolean
            materials: boolean
          reproducible: boolean
        recipe:
          defined-in-material: string
          entry-point: string
          type: string
      slsa-provenance:
        builder:
          id: string
        metadata:
          build-finished-on: string
          build-invocation-id: string
          build-started-on: string
          completeness:
            arguments: boolean
            environment: boolean
            materials: boolean
          reproducible: boolean
        recipe:
          defined-in-material: string
          entry-point: string
          type: string
      slsa-provenance-zero-two:
        build-type: string
        builder:
          id: string
        invocation:
          config-source:
            digest: { string: string }
            entry-point: string
            uri: string
        metadata:
          build-finished-on: string
          build-invocation-id: string
          build-started-on: string
          completeness:
            environment: boolean
            materials: boolean
            parameters: boolean
          reproducible: boolean
  envelope:
    payload: string
    payload-type: string
  image:
    base-resource-url: string
    distance: integer
    fingerprint:
      v1-name: string
      v2-blob: [string]
      v2-name: string
  kind: string
  name: string
  note-name: string
  package:
    architecture: string
    cpe-uri: string
    license:
      comments: string
      expression: string
    name: string
    package-type: string
    version:
      epoch: integer
      full-name: string
      inclusive: boolean
      kind: string
      name: string
      revision: string
  remediation: string
  resource-uri: string
  sbom-reference:
    payload:
      -type: string
      predicate:
        digest: { string: string }
        location: string
        mime-type: string
        referrer-id: string
      predicate-type: string
    payload-type: string
  update-time: string
  upgrade:
    distribution:
      classification: string
      cpe-uri: string
      cve: [string]
      severity: string
    package: string
    parsed-version:
      epoch: integer
      full-name: string
      inclusive: boolean
      kind: string
      name: string
      revision: string
    windows-update:
      description: string
      identity:
        revision: integer
        update-id: string
      kb-article-ids: [string]
      last-published-timestamp: string
      support-url: string
      title: string
  vulnerability:
    cvss-score: number
    cvss-v2:
      attack-complexity: string
      attack-vector: string
      authentication: string
      availability-impact: string
      base-score: number
      confidentiality-impact: string
      exploitability-score: number
      impact-score: number
      integrity-impact: string
      privileges-required: string
      scope: string
      user-interaction: string
    cvss-version: string
    cvssv3:
      attack-complexity: string
      attack-vector: string
      authentication: string
      availability-impact: string
      base-score: number
      confidentiality-impact: string
      exploitability-score: number
      impact-score: number
      integrity-impact: string
      privileges-required: string
      scope: string
      user-interaction: string
    effective-severity: string
    extra-details: string
    fix-available: boolean
    long-description: string
    severity: string
    short-description: string
    type: string
    vex-assessment:
      cve: string
      impacts: [string]
      justification:
        details: string
        justification-type: string
      note-name: string
      state: string
      vulnerability-id: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .attestation serialized-payload=nonumy

    • Required. The serialized payload that is verified by one or more signatures.
  • ..build.in-toto-slsa-provenance-v1 -type=stet

    • InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement
  • predicate.build-definition build-type=rebum.

    • No description provided.
  • ..run-details.builder id=eirmod

    • No description provided.
  • version=key=dolores

    • No description provided.
    • the value will be associated with the given key
  • ..metadata finished-on=aliquyam

    • No description provided.
  • invocation-id=sanctus
    • No description provided.
  • started-on=invidunt

    • No description provided.
  • .... predicate-type=dolor

    • No description provided.
  • ..intoto-provenance.builder-config id=eos

    • No description provided.
  • .. materials=magna

    • The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
    • Each invocation of this argument appends the given value to the array.
  • metadata build-finished-on=no
    • The timestamp of when the build completed.
  • build-invocation-id=gubergren
    • Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
  • build-started-on=erat
    • The timestamp of when the build started.
  • completeness arguments=false
    • If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
  • environment=false
    • If true, the builder claims that recipe.environment is claimed to be complete.
  • materials=false

    • If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
  • .. reproducible=false

    • If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
  • ..recipe defined-in-material=justo

    • Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
  • entry-point=lorem
    • String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
  • type=labore

    • URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
  • ...intoto-statement -type=gubergren

    • Always https://in-toto.io/Statement/v0.1.
  • predicate-type=vero
    • https://slsa.dev/provenance/v0.1 for SlsaProvenance.
  • provenance.builder-config id=ea

    • No description provided.
  • .. materials=sed

    • The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
    • Each invocation of this argument appends the given value to the array.
  • metadata build-finished-on=sanctus
    • The timestamp of when the build completed.
  • build-invocation-id=labore
    • Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
  • build-started-on=amet
    • The timestamp of when the build started.
  • completeness arguments=true
    • If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
  • environment=true
    • If true, the builder claims that recipe.environment is claimed to be complete.
  • materials=false

    • If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
  • .. reproducible=false

    • If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
  • ..recipe defined-in-material=voluptua.

    • Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
  • entry-point=sea
    • String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
  • type=ipsum

    • URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
  • ...slsa-provenance.builder id=sea

    • No description provided.
  • ..metadata build-finished-on=et

    • The timestamp of when the build completed.
  • build-invocation-id=gubergren
    • Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
  • build-started-on=dolore
    • The timestamp of when the build started.
  • completeness arguments=false
    • If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
  • environment=false
    • If true, the builder claims that recipe.environment is claimed to be complete.
  • materials=false

    • If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
  • .. reproducible=true

    • If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
  • ..recipe defined-in-material=sed

    • Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
  • entry-point=no
    • String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
  • type=stet

    • URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
  • ...slsa-provenance-zero-two build-type=sea

    • No description provided.
  • builder id=clita

    • No description provided.
  • ..invocation.config-source digest=key=consetetur

    • No description provided.
    • the value will be associated with the given key
  • entry-point=dolores
    • No description provided.
  • uri=sit

    • No description provided.
  • ...metadata build-finished-on=sea

    • No description provided.
  • build-invocation-id=sanctus
    • No description provided.
  • build-started-on=kasd
    • No description provided.
  • completeness environment=false
    • No description provided.
  • materials=true
    • No description provided.
  • parameters=true

    • No description provided.
  • .. reproducible=false

    • No description provided.
  • ....provenance build-options=key=sea

    • Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.
    • the value will be associated with the given key
  • builder-version=sadipscing
    • Version string of the builder at the time this build was executed.
  • create-time=dolore
    • Time at which the build was created.
  • creator=amet
    • E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.
  • end-time=invidunt
    • Time at which execution of the build was finished.
  • id=invidunt
    • Required. Unique identifier of the build.
  • logs-uri=dolores
    • URI where any logs for this provenance were written.
  • project-id=diam
    • ID of the project.
  • source-provenance artifact-storage-source-uri=sanctus
    • If provided, the input binary artifacts for the build came from this location.
  • context.cloud-repo.alias-context kind=sed
    • The alias kind.
  • name=eos

    • The alias name.
  • ..repo-id.project-repo-id project-id=sit

    • The ID of the project.
  • repo-name=et

    • The name of the repo. Leave empty for the default repo.
  • .. uid=ea

    • A server-assigned, globally unique identifier.
  • .. revision-id=dolor

    • A revision ID.
  • ..gerrit.alias-context kind=sadipscing

    • The alias kind.
  • name=diam

    • The alias name.
  • .. gerrit-project=at

    • The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.
  • host-uri=at
    • The URI of a running Gerrit instance.
  • revision-id=kasd

    • A revision (commit) ID.
  • ..git revision-id=magna

    • Git commit hash.
  • url=amet.

    • Git repository URL.
  • .. labels=key=est

    • Labels with user defined metadata.
    • the value will be associated with the given key
  • ... start-time=gubergren

    • Time at which execution of the build was started.
  • trigger-id=eos

    • Trigger identifier if the build was triggered automatically; empty if not.
  • .. provenance-bytes=dolore

    • Serialized JSON representation of the provenance, used in generating the build signature in the corresponding build note. After verifying the signature, provenance_bytes can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.
  • ..compliance non-compliance-reason=tempor

    • No description provided.
  • .. create-time=stet

    • Output only. The time this occurrence was created.
  • deployment address=accusam
    • Address of the runtime element hosting this deployment.
  • config=et
    • Configuration used to create this deployment.
  • deploy-time=dolor
    • Required. Beginning of the lifetime of this deployment.
  • platform=diam
    • Platform hosting this deployment.
  • resource-uri=elitr
    • Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.
    • Each invocation of this argument appends the given value to the array.
  • undeploy-time=sea
    • End of the lifetime of this deployment.
  • user-email=vero

    • Identity of the user that triggered this deployment.
  • ..discovery.analysis-completed analysis-type=et

    • No description provided.
    • Each invocation of this argument appends the given value to the array.
  • .. analysis-status=lorem

    • The status of discovery for the resource.
  • analysis-status-error code=48
    • The status code, which should be an enum value of google.rpc.Code.
  • message=lorem

    • A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  • .. archive-time=amet.

    • Output only. The time occurrences related to this discovery occurrence were archived.
  • continuous-analysis=diam
    • Whether the resource is continuously analyzed.
  • cpe=diam
    • The CPE of the resource being scanned.
  • last-scan-time=et
    • The last time this resource was scanned.
  • sbom-status error=takimata
    • If there was an error generating an SBOM, this will indicate what that error was.
  • sbom-state=et

    • The progress of the SBOM generation.
  • ...dsse-attestation.envelope payload=dolores

    • No description provided.
  • payload-type=dolores

    • No description provided.
  • ..statement -type=diam

    • Always https://in-toto.io/Statement/v0.1.
  • predicate-type=ea
    • https://slsa.dev/provenance/v0.1 for SlsaProvenance.
  • provenance.builder-config id=sea

    • No description provided.
  • .. materials=dolore

    • The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on. This is considered to be incomplete unless metadata.completeness.materials is true. Unset or null is equivalent to empty.
    • Each invocation of this argument appends the given value to the array.
  • metadata build-finished-on=dolores
    • The timestamp of when the build completed.
  • build-invocation-id=invidunt
    • Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
  • build-started-on=tempor
    • The timestamp of when the build started.
  • completeness arguments=false
    • If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
  • environment=false
    • If true, the builder claims that recipe.environment is claimed to be complete.
  • materials=true

    • If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
  • .. reproducible=true

    • If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
  • ..recipe defined-in-material=et

    • Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
  • entry-point=labore
    • String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
  • type=labore

    • URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
  • ...slsa-provenance.builder id=et

    • No description provided.
  • ..metadata build-finished-on=aliquyam

    • The timestamp of when the build completed.
  • build-invocation-id=ut
    • Identifies the particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis. The value SHOULD be globally unique, per in-toto Provenance spec.
  • build-started-on=amet.
    • The timestamp of when the build started.
  • completeness arguments=true
    • If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.
  • environment=true
    • If true, the builder claims that recipe.environment is claimed to be complete.
  • materials=false

    • If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called "hermetic".
  • .. reproducible=true

    • If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.
  • ..recipe defined-in-material=eirmod

    • Index in materials containing the recipe steps that are not implied by recipe.type. For example, if the recipe type were "make", then this would point to the source containing the Makefile, not the make program itself. Set to -1 if the recipe doesn't come from a material, as zero is default unset value for int64.
  • entry-point=amet.
    • String identifying the entry point into the build. This is often a path to a configuration file and/or a target label within that file. The syntax and meaning are defined by recipe.type. For example, if the recipe type were "make", then this would reference the directory in which to run make as well as which target to use.
  • type=takimata

    • URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.
  • ...slsa-provenance-zero-two build-type=amet.

    • No description provided.
  • builder id=et

    • No description provided.
  • ..invocation.config-source digest=key=labore

    • No description provided.
    • the value will be associated with the given key
  • entry-point=sed
    • No description provided.
  • uri=sit

    • No description provided.
  • ...metadata build-finished-on=sit

    • No description provided.
  • build-invocation-id=invidunt
    • No description provided.
  • build-started-on=elitr
    • No description provided.
  • completeness environment=false
    • No description provided.
  • materials=false
    • No description provided.
  • parameters=false

    • No description provided.
  • .. reproducible=false

    • No description provided.
  • .....envelope payload=no

    • No description provided.
  • payload-type=sit

    • No description provided.
  • ..image base-resource-url=est

    • Output only. This contains the base image URL for the derived image occurrence.
  • distance=7
    • Output only. The number of layers by which this image differs from the associated image basis.
  • fingerprint v1-name=et
    • Required. The layer ID of the final layer in the Docker image's v1 representation.
  • v2-blob=consetetur
    • Required. The ordered list of v2 blobs that represent a given image.
    • Each invocation of this argument appends the given value to the array.
  • v2-name=at

    • Output only. The name of the image's v2 blobs computed via: [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the final blob is kept.
  • ... kind=et

    • Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests.
  • name=accusam
    • Output only. The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].
  • note-name=sit
    • 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 architecture=voluptua.
    • Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
  • cpe-uri=kasd
    • Output only. The cpe_uri in CPE format denoting the package manager version distributing a package. The cpe_uri will be blank for language packages.
  • license comments=no
    • Comments
  • expression=amet.

    • Often a single license can be used to represent the licensing terms. Sometimes it is necessary to include a choice of one or more licenses or some combination of license identifiers. Examples: "LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later WITH Bison-exception-2.2".
  • .. name=aliquyam

    • Required. Output only. The name of the installed package.
  • package-type=accusam
    • Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
  • version epoch=43
    • Used to correct mistakes in the version numbering scheme.
  • full-name=duo
    • Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
  • inclusive=true
    • Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
  • kind=eos
    • Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
  • name=no
    • Required only when version kind is NORMAL. The main part of the version name.
  • revision=kasd

    • The iteration of the package build from the above version.
  • ... remediation=sanctus

    • A description of actions that can be taken to remedy the note.
  • resource-uri=gubergren
    • 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.
  • sbom-reference.payload -type=accusam
    • Identifier for the schema of the Statement.
  • predicate digest=key=lorem
    • A map of algorithm to digest of the contents of the SBOM.
    • the value will be associated with the given key
  • location=dolor
    • The location of the SBOM.
  • mime-type=sanctus
    • The mime type of the SBOM.
  • referrer-id=sea

    • The person or system referring this predicate to the consumer.
  • .. predicate-type=diam

    • URI identifying the type of the Predicate.
  • .. payload-type=amet

    • The kind of payload that SbomReferenceIntotoPayload takes. Since it's in the intoto format, this value is expected to be 'application/vnd.in-toto+json'.
  • .. update-time=magna

    • Output only. The time this occurrence was last updated.
  • upgrade.distribution classification=accusam
    • The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed. For Windows the classification is one of the category_ids listed at https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ff357803(v=vs.85)
  • cpe-uri=lorem
    • Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.
  • cve=tempor
    • The cve tied to this Upgrade.
    • Each invocation of this argument appends the given value to the array.
  • severity=consetetur

    • The severity as specified by the upstream operating system.
  • .. package=amet

    • Required for non-Windows OS. The package this Upgrade is for.
  • parsed-version epoch=51
    • Used to correct mistakes in the version numbering scheme.
  • full-name=et
    • Human readable version string. This string is of the form :- and is only set when kind is NORMAL.
  • inclusive=true
    • Whether this version is specifying part of an inclusive range. Grafeas does not have the capability to specify version ranges; instead we have fields that specify start version and end versions. At times this is insufficient - we also need to specify whether the version is included in the range or is excluded from the range. This boolean is expected to be set to true when the version is included in a range.
  • kind=dolor
    • Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
  • name=duo
    • Required only when version kind is NORMAL. The main part of the version name.
  • revision=diam

    • The iteration of the package build from the above version.
  • ..windows-update description=et

    • The localized description of the update.
  • identity revision=0
    • The revision number of the update.
  • update-id=no

    • The revision independent identifier of the update.
  • .. kb-article-ids=sea

    • The Microsoft Knowledge Base article IDs that are associated with the update.
    • Each invocation of this argument appends the given value to the array.
  • last-published-timestamp=et
    • The last published timestamp of the update.
  • support-url=voluptua.
    • The hyperlink to the support information for the update.
  • title=ipsum

    • The localized title of the update.
  • ...vulnerability cvss-score=0.2666559945853675

    • Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
  • cvss-v2 attack-complexity=eos
    • No description provided.
  • attack-vector=vero
    • Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
  • authentication=sanctus
    • No description provided.
  • availability-impact=dolores
    • No description provided.
  • base-score=0.45119915289294743
    • The base score is a function of the base metric scores.
  • confidentiality-impact=sed
    • No description provided.
  • exploitability-score=0.001595441516040963
    • No description provided.
  • impact-score=0.6380468999017728
    • No description provided.
  • integrity-impact=no
    • No description provided.
  • privileges-required=sadipscing
    • No description provided.
  • scope=sit
    • No description provided.
  • user-interaction=duo

    • No description provided.
  • .. cvss-version=stet

    • Output only. CVSS version used to populate cvss_score and severity.
  • cvssv3 attack-complexity=diam
    • No description provided.
  • attack-vector=accusam
    • Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
  • authentication=dolore
    • No description provided.
  • availability-impact=eirmod
    • No description provided.
  • base-score=0.3933268421172649
    • The base score is a function of the base metric scores.
  • confidentiality-impact=est
    • No description provided.
  • exploitability-score=0.049386894448035235
    • No description provided.
  • impact-score=0.013416310990004843
    • No description provided.
  • integrity-impact=et
    • No description provided.
  • privileges-required=ut
    • No description provided.
  • scope=et
    • No description provided.
  • user-interaction=et

    • No description provided.
  • .. effective-severity=at

    • The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues.
  • extra-details=sed
    • Occurrence-specific extra details about the vulnerability.
  • fix-available=true
    • Output only. Whether at least one of the affected packages has a fix available.
  • long-description=sadipscing
    • Output only. A detailed description of this vulnerability.
  • severity=voluptua.
    • Output only. The note provider assigned severity of this vulnerability.
  • short-description=et
    • Output only. A one sentence description of this vulnerability.
  • type=clita
    • The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
  • vex-assessment cve=sit
    • Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
  • impacts=rebum.
    • Contains information about the impact of this vulnerability, this will change with time.
    • Each invocation of this argument appends the given value to the array.
  • justification details=sanctus
    • Additional details on why this justification was chosen.
  • justification-type=no

    • The justification type for this vulnerability.
  • .. note-name=stet

    • The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: projects/[PROJECT_ID]/notes/[NOTE_ID].
  • state=diam
    • Provides the state of this Vulnerability assessment.
  • vulnerability-id=ipsum
    • The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • The fields to update.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").