Creates a new note.

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-beta1 --scope <scope> projects notes-create ...

Required Scalar Argument

• <parent> (string)
  • Required. The name of the project in the form of projects/[PROJECT_ID], under which the note is to be created.

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:

Note:
  attestation-authority:
    hint:
      human-readable-name: string
  base-image:
    fingerprint:
      v1-name: string
      v2-blob: [string]
      v2-name: string
    resource-url: string
  build:
    builder-version: string
    signature:
      key-id: string
      key-type: string
      public-key: string
      signature: string
  create-time: string
  deployable:
    resource-uri: [string]
  discovery:
    analysis-kind: string
  expiration-time: string
  intoto:
    expected-command: [string]
    step-name: string
    threshold: string
  kind: string
  long-description: string
  name: string
  package:
    architecture: string
    cpe-uri: string
    description: string
    license:
      comments: string
      expression: string
    maintainer: string
    name: string
    package-type: string
    url: string
    version:
      epoch: integer
      inclusive: boolean
      kind: string
      name: string
      revision: string
  related-note-names: [string]
  sbom:
    data-licence: string
    spdx-version: string
  sbom-reference:
    format: string
    version: string
  short-description: string
  spdx-file:
    checksum: [string]
    file-type: string
    title: string
  spdx-package:
    analyzed: boolean
    attribution: string
    checksum: string
    copyright: string
    detailed-description: string
    download-location: string
    files-license-info: [string]
    home-page: string
    license-declared:
      comments: string
      expression: string
    originator: string
    package-type: string
    summary-description: string
    supplier: string
    title: string
    verification-code: string
    version: string
  spdx-relationship:
    type: string
  update-time: 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-v3:
      attack-complexity: string
      attack-vector: 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
    cwe: [string]
    severity: string
    source-update-time: string
  vulnerability-assessment:
    assessment:
      cve: string
      impacts: [string]
      justification:
        details: string
        justification-type: string
      long-description: string
      short-description: string
      state: string
      vulnerability-id: string
    language-code: string
    long-description: string
    product:
      generic-uri: string
      id: string
      name: string
    publisher:
      issuing-authority: string
      name: string
      publisher-namespace: string
    short-description: string
    title: 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-authority.hint human-readable-name=et

  • Required. The human readable name of this attestation authority, for example "qa".

• ...base-image.fingerprint v1-name=magna

  • Required. The layer ID of the final layer in the Docker image's v1 representation.
• v2-blob=no
  • 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=ipsum

  • 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.

• .. resource-url=voluptua.

  • Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images.

• ..build builder-version=at

  • Required. Immutable. Version of the builder which produced this build.
• signature key-id=sanctus
  • An ID for the key used to sign. This could be either an ID for the key stored in public_key (such as the ID or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).
• key-type=sed
  • The type of the key, either stored in public_key or referenced in key_id.
• public-key=amet.
  • Public key of the builder which can be used to verify that the related findings are valid and unchanged. If key_type is empty, this defaults to PEM encoded public keys. This field may be empty if key_id references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from BuildDetails are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: openssl sha256 -verify public.pem -signature signature.bin signed.bin

• signature=takimata

  • Required. Signature of the related BuildProvenance. In JSON, this is base-64 encoded.

• ... create-time=amet.

  • Output only. The time this note was created. This field can be used as a filter in list requests.

• deployable resource-uri=duo

  • Required. Resource URI for the artifact being deployed.
  • Each invocation of this argument appends the given value to the array.

• ..discovery analysis-kind=ipsum

  • Required. Immutable. The kind of analysis that is handled by this discovery.

• .. expiration-time=gubergren

  • Time of expiration for this note. Empty if note does not expire.
• intoto expected-command=lorem
  • This field contains the expected command used to perform the step.
  • Each invocation of this argument appends the given value to the array.
• step-name=gubergren
  • This field identifies the name of the step in the supply chain.

• threshold=eos

  • This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link.

• .. kind=dolor

  • Output only. The type of analysis. This field can be used as a filter in list requests.
• long-description=ea
  • A detailed description of this note.
• name=ipsum
  • Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
• package architecture=invidunt
  • The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.
• cpe-uri=amet
  • The cpe_uri in CPE format denoting the package manager version distributing a package. The cpe_uri will be blank for language packages.
• description=duo
  • The description of this package.
• license comments=ipsum
  • Comments

• expression=sed

  • 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".

• .. maintainer=ut

  • A freeform text denoting the maintainer of this package.
• name=gubergren
  • Required. Immutable. The name of the package.
• package-type=rebum.
  • The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).
• url=est
  • The homepage for this package.
• version epoch=51
  • Used to correct mistakes in the version numbering scheme.
• 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=est
  • Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
• name=gubergren
  • Required only when version kind is NORMAL. The main part of the version name.

• revision=ea

  • The iteration of the package build from the above version.

• ... related-note-names=dolor

  • Other notes related to this note.
  • Each invocation of this argument appends the given value to the array.
• sbom data-licence=lorem
  • Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields ("SPDX-Metadata")

• spdx-version=eos

  • Provide a reference number that can be used to understand how to parse and interpret the rest of the file

• ..sbom-reference format=labore

  • The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...

• version=sed

  • The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3.

• .. short-description=duo

  • A one sentence description of this note.
• spdx-file checksum=sed
  • Provide a unique identifier to match analysis information on each specific file in a package
  • Each invocation of this argument appends the given value to the array.
• file-type=no
  • This field provides information about the type of file identified

• title=stet

  • Identify the full path and filename that corresponds to the file information in this section

• ..spdx-package analyzed=true

  • Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document
• attribution=et
  • A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts
• checksum=et
  • Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file
• copyright=vero
  • Identify the copyright holders of the package, as well as any dates present
• detailed-description=erat
  • A more detailed description of the package
• download-location=sed
  • This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created
• files-license-info=duo
  • Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found
  • Each invocation of this argument appends the given value to the array.
• home-page=dolore
  • Provide a place for the SPDX file creator to record a web site that serves as the package's home page
• license-declared comments=et
  • Comments

• expression=voluptua.

  • 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".

• .. originator=amet.

  • If the package identified in the SPDX file originated from a different person or organization than identified as Package Supplier, this field identifies from where or whom the package originally came
• package-type=consetetur
  • The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
• summary-description=diam
  • A short description of the package
• supplier=dolor
  • Identify the actual distribution source for the package/directory identified in the SPDX file
• title=et
  • Identify the full name of the package as given by the Package Originator
• verification-code=et
  • This field provides an independently reproducible mechanism identifying specific contents of a package based on the actual files (except the SPDX file itself, if it is included in the package) that make up each package and that correlates to the data in this SPDX file

• version=sadipscing

  • Identify the version of the package

• ..spdx-relationship type=stet

  • The type of relationship between the source and target SPDX elements

• .. update-time=dolor

  • Output only. The time this note was last updated. This field can be used as a filter in list requests.
• vulnerability cvss-score=0.6349978834153693
  • The CVSS score for this vulnerability.
• cvss-v2 attack-complexity=vero
  • Defined in CVSS v3, CVSS v2
• attack-vector=invidunt
  • Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2
• authentication=stet
  • Defined in CVSS v2
• availability-impact=vero
  • Defined in CVSS v3, CVSS v2
• base-score=0.4523282032393763
  • The base score is a function of the base metric scores.
• confidentiality-impact=diam
  • Defined in CVSS v3, CVSS v2
• exploitability-score=0.31428290912855783
  • No description provided.
• impact-score=0.7954074288671369
  • No description provided.
• integrity-impact=accusam
  • Defined in CVSS v3, CVSS v2
• privileges-required=takimata
  • Defined in CVSS v3
• scope=consetetur
  • Defined in CVSS v3

• user-interaction=voluptua.

  • Defined in CVSS v3

• ..cvss-v3 attack-complexity=et

  • No description provided.
• attack-vector=erat
  • Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments.
• availability-impact=consetetur
  • No description provided.
• base-score=0.7759968264300798
  • The base score is a function of the base metric scores.
• confidentiality-impact=sed
  • No description provided.
• exploitability-score=0.726541471822237
  • No description provided.
• impact-score=0.3072987560065821
  • No description provided.
• integrity-impact=et
  • No description provided.
• privileges-required=accusam
  • No description provided.
• scope=voluptua.
  • No description provided.

• user-interaction=dolore

  • No description provided.

• .. cvss-version=dolore

  • CVSS version used to populate cvss_score and severity.
• cwe=dolore
  • A list of CWE for this vulnerability. For details, see: https://cwe.mitre.org/index.html
  • Each invocation of this argument appends the given value to the array.
• severity=voluptua.
  • Note provider assigned impact of the vulnerability.

• source-update-time=amet.

  • The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker.

• ..vulnerability-assessment.assessment cve=ea

  • Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability. Deprecated: Use vulnerability_id instead to denote CVEs.
• impacts=sadipscing
  • 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=lorem
  • Additional details on why this justification was chosen.

• justification-type=invidunt

  • The justification type for this vulnerability.

• .. long-description=no

  • A detailed description of this Vex.
• short-description=est
  • A one sentence description of this Vex.
• state=at
  • Provides the state of this Vulnerability assessment.

• vulnerability-id=sed

  • The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.

• .. language-code=sit

  • Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646.
• long-description=et
  • A detailed description of this Vex.
• product generic-uri=tempor
  • Contains a URI which is vendor-specific. Example: The artifact repository URL of an image.
• id=aliquyam
  • Token that identifies a product so that it can be referred to from other parts in the document. There is no predefined format as long as it uniquely identifies a group in the context of the current document.

• name=ipsum

  • Name of the product.

• ..publisher issuing-authority=et

  • Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations.
• name=sanctus
  • Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.

• publisher-namespace=lorem

  • The context or namespace. Contains a URL which is under control of the issuing party and can be used as a globally unique identifier for that issuing party. Example: https://csaf.io

• .. short-description=est

  • A one sentence description of this Vex.
• title=sed
  • The title of the note. E.g. Vex-Debian-11.4

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 note-id=string
  • Required. The ID to use for this note.

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").