chore: regens API reference docs (#889)
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
index 83d56d3..493eac1 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
@@ -75,7 +75,7 @@
<h1><a href="containeranalysis_v1alpha1.html">Container Analysis API</a> . <a href="containeranalysis_v1alpha1.projects.html">projects</a> . <a href="containeranalysis_v1alpha1.projects.occurrences.html">occurrences</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, name=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new `Occurrence`. Use this method to create `Occurrences`</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -99,26 +99,81 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing occurrence.</p>
<p class="toc_element">
- <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on the specified `Note` or `Occurrence`.</p>
<p class="toc_element">
- <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the permissions that a caller has on the specified note or</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, name=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code>
<pre>Creates a new `Occurrence`. Use this method to create `Occurrences`
for a resource.
Args:
parent: string, This field contains the project Id for example: "projects/{project_id}" (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # `Occurrence` includes information about analysis occurrences for an image.
+ "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
+ # to fix it.
+ "packageIssue": [ # The set of affected locations and their fixes (if available) within
+ # the associated resource.
+ { # This message wraps a location affected by a vulnerability and its
+ # associated fix (if one is available).
+ "severityName": "A String",
+ "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ },
+ ],
+ "type": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cvssScore": 3.14, # 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.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
+ # available and note provider assigned severity when distro has not yet
+ # assigned a severity for this vulnerability.
+ },
"resource": { # #
# The resource for which the `Occurrence` applies.
# Resource is an entity that can have metadata. E.g., a Docker image.
@@ -126,11 +181,41 @@
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
+ "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
"uri": "A String", # The unique URI of the resource. E.g.,
# "https://gcr.io/project/image@sha256:foo" for a Docker image.
- "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
},
"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
+ "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
+ # 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).
+ "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
+ # for the resource_url. This allows efficient filtering, as well as
+ # making it easier to use the occurrence.
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
# a system.
"location": [ # All of the places within the filesystem versions of this package
@@ -146,11 +231,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -197,9 +282,9 @@
# Repository.
"projectId": "A String", # ID of the project that owns the repo.
"branchName": "A String", # Name of the branch to build.
- "repoName": "A String", # Name of the repo.
- "tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
+ "tagName": "A String", # Name of the tag to build.
+ "repoName": "A String", # Name of the repo.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build.
@@ -228,8 +313,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -239,12 +323,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -256,10 +340,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
],
@@ -268,8 +352,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -279,12 +362,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -296,10 +379,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
@@ -319,7 +402,7 @@
"creator": "A String", # 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.
- "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
+ "projectId": "A String", # ID of the project.
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"createTime": "A String", # Time at which the build was created.
"builtArtifacts": [ # Output of the build.
@@ -347,7 +430,7 @@
],
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"startTime": "A String", # Time at which execution of the build was started.
- "projectId": "A String", # ID of the project.
+ "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
"id": "A String", # Unique identifier of the build.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
@@ -408,6 +491,8 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
+ "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "cpe": "A String", # The CPE of the resource being scanned.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
# details to show to the user. The LocalizedMessage output only and
# populated by the API.
@@ -428,7 +513,6 @@
},
],
},
- "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
},
"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
# Attestation can be verified using the attached signature. If the verifier
@@ -453,7 +537,7 @@
# gpg --with-colons --with-fingerprint --force-v4-certs \
# --list-keys attester@example.com
# tru::1:1513631572:0:3:1:5
- # pub:...<SNIP>...
+ # pub:...<SNIP>...
# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
# ```
# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
@@ -488,66 +572,14 @@
"config": "A String", # Configuration used to create this deployment.
},
"remediation": "A String", # A description of actions that can be taken to remedy the `Note`
- "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
- # to fix it.
- "packageIssue": [ # The set of affected locations and their fixes (if available) within
- # the associated resource.
- { # This message wraps a location affected by a vulnerability and its
- # associated fix (if one is available).
- "severityName": "A String",
- "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- },
- ],
- "type": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cvssScore": 3.14, # 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.
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
- # available and note provider assigned severity when distro has not yet
- # assigned a severity for this vulnerability.
- },
+ "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
+ # applies. For example, https://gcr.io/project/image@sha256:foo This field
+ # can be used as a filter in list requests.
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
# in the associated note.
# DockerImage relationship. This image would be produced from a Dockerfile
- # with FROM <DockerImage.Basis in attached Note>.
+ # with FROM <DockerImage.Basis in attached Note>.
"distance": 42, # Output only. The number of layers by which this image differs from the
# associated image basis.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
@@ -573,9 +605,6 @@
# This field can be used as a filter in list requests.
},
},
- "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
- # applies. For example, https://gcr.io/project/image@sha256:foo This field
- # can be used as a filter in list requests.
}
name: string, The name of the project. Should be of the form "projects/{project_id}".
@@ -589,6 +618,61 @@
An object of the form:
{ # `Occurrence` includes information about analysis occurrences for an image.
+ "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
+ # to fix it.
+ "packageIssue": [ # The set of affected locations and their fixes (if available) within
+ # the associated resource.
+ { # This message wraps a location affected by a vulnerability and its
+ # associated fix (if one is available).
+ "severityName": "A String",
+ "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ },
+ ],
+ "type": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cvssScore": 3.14, # 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.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
+ # available and note provider assigned severity when distro has not yet
+ # assigned a severity for this vulnerability.
+ },
"resource": { # #
# The resource for which the `Occurrence` applies.
# Resource is an entity that can have metadata. E.g., a Docker image.
@@ -596,11 +680,41 @@
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
+ "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
"uri": "A String", # The unique URI of the resource. E.g.,
# "https://gcr.io/project/image@sha256:foo" for a Docker image.
- "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
},
"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
+ "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
+ # 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).
+ "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
+ # for the resource_url. This allows efficient filtering, as well as
+ # making it easier to use the occurrence.
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
# a system.
"location": [ # All of the places within the filesystem versions of this package
@@ -616,11 +730,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -667,9 +781,9 @@
# Repository.
"projectId": "A String", # ID of the project that owns the repo.
"branchName": "A String", # Name of the branch to build.
- "repoName": "A String", # Name of the repo.
- "tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
+ "tagName": "A String", # Name of the tag to build.
+ "repoName": "A String", # Name of the repo.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build.
@@ -698,8 +812,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -709,12 +822,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -726,10 +839,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
],
@@ -738,8 +851,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -749,12 +861,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -766,10 +878,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
@@ -789,7 +901,7 @@
"creator": "A String", # 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.
- "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
+ "projectId": "A String", # ID of the project.
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"createTime": "A String", # Time at which the build was created.
"builtArtifacts": [ # Output of the build.
@@ -817,7 +929,7 @@
],
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"startTime": "A String", # Time at which execution of the build was started.
- "projectId": "A String", # ID of the project.
+ "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
"id": "A String", # Unique identifier of the build.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
@@ -878,6 +990,8 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
+ "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "cpe": "A String", # The CPE of the resource being scanned.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
# details to show to the user. The LocalizedMessage output only and
# populated by the API.
@@ -898,7 +1012,6 @@
},
],
},
- "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
},
"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
# Attestation can be verified using the attached signature. If the verifier
@@ -923,7 +1036,7 @@
# gpg --with-colons --with-fingerprint --force-v4-certs \
# --list-keys attester@example.com
# tru::1:1513631572:0:3:1:5
- # pub:...<SNIP>...
+ # pub:...<SNIP>...
# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
# ```
# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
@@ -958,66 +1071,14 @@
"config": "A String", # Configuration used to create this deployment.
},
"remediation": "A String", # A description of actions that can be taken to remedy the `Note`
- "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
- # to fix it.
- "packageIssue": [ # The set of affected locations and their fixes (if available) within
- # the associated resource.
- { # This message wraps a location affected by a vulnerability and its
- # associated fix (if one is available).
- "severityName": "A String",
- "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- },
- ],
- "type": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cvssScore": 3.14, # 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.
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
- # available and note provider assigned severity when distro has not yet
- # assigned a severity for this vulnerability.
- },
+ "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
+ # applies. For example, https://gcr.io/project/image@sha256:foo This field
+ # can be used as a filter in list requests.
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
# in the associated note.
# DockerImage relationship. This image would be produced from a Dockerfile
- # with FROM <DockerImage.Basis in attached Note>.
+ # with FROM <DockerImage.Basis in attached Note>.
"distance": 42, # Output only. The number of layers by which this image differs from the
# associated image basis.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
@@ -1043,9 +1104,6 @@
# This field can be used as a filter in list requests.
},
},
- "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
- # applies. For example, https://gcr.io/project/image@sha256:foo This field
- # can be used as a filter in list requests.
}</pre>
</div>
@@ -1093,6 +1151,61 @@
An object of the form:
{ # `Occurrence` includes information about analysis occurrences for an image.
+ "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
+ # to fix it.
+ "packageIssue": [ # The set of affected locations and their fixes (if available) within
+ # the associated resource.
+ { # This message wraps a location affected by a vulnerability and its
+ # associated fix (if one is available).
+ "severityName": "A String",
+ "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ },
+ ],
+ "type": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cvssScore": 3.14, # 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.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
+ # available and note provider assigned severity when distro has not yet
+ # assigned a severity for this vulnerability.
+ },
"resource": { # #
# The resource for which the `Occurrence` applies.
# Resource is an entity that can have metadata. E.g., a Docker image.
@@ -1100,11 +1213,41 @@
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
+ "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
"uri": "A String", # The unique URI of the resource. E.g.,
# "https://gcr.io/project/image@sha256:foo" for a Docker image.
- "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
},
"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
+ "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
+ # 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).
+ "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
+ # for the resource_url. This allows efficient filtering, as well as
+ # making it easier to use the occurrence.
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
# a system.
"location": [ # All of the places within the filesystem versions of this package
@@ -1120,11 +1263,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -1171,9 +1314,9 @@
# Repository.
"projectId": "A String", # ID of the project that owns the repo.
"branchName": "A String", # Name of the branch to build.
- "repoName": "A String", # Name of the repo.
- "tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
+ "tagName": "A String", # Name of the tag to build.
+ "repoName": "A String", # Name of the repo.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build.
@@ -1202,8 +1345,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -1213,12 +1355,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -1230,10 +1372,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
],
@@ -1242,8 +1384,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -1253,12 +1394,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -1270,10 +1411,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
@@ -1293,7 +1434,7 @@
"creator": "A String", # 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.
- "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
+ "projectId": "A String", # ID of the project.
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"createTime": "A String", # Time at which the build was created.
"builtArtifacts": [ # Output of the build.
@@ -1321,7 +1462,7 @@
],
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"startTime": "A String", # Time at which execution of the build was started.
- "projectId": "A String", # ID of the project.
+ "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
"id": "A String", # Unique identifier of the build.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
@@ -1382,6 +1523,8 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
+ "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "cpe": "A String", # The CPE of the resource being scanned.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
# details to show to the user. The LocalizedMessage output only and
# populated by the API.
@@ -1402,7 +1545,6 @@
},
],
},
- "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
},
"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
# Attestation can be verified using the attached signature. If the verifier
@@ -1427,7 +1569,7 @@
# gpg --with-colons --with-fingerprint --force-v4-certs \
# --list-keys attester@example.com
# tru::1:1513631572:0:3:1:5
- # pub:...<SNIP>...
+ # pub:...<SNIP>...
# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
# ```
# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
@@ -1462,66 +1604,14 @@
"config": "A String", # Configuration used to create this deployment.
},
"remediation": "A String", # A description of actions that can be taken to remedy the `Note`
- "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
- # to fix it.
- "packageIssue": [ # The set of affected locations and their fixes (if available) within
- # the associated resource.
- { # This message wraps a location affected by a vulnerability and its
- # associated fix (if one is available).
- "severityName": "A String",
- "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- },
- ],
- "type": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cvssScore": 3.14, # 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.
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
- # available and note provider assigned severity when distro has not yet
- # assigned a severity for this vulnerability.
- },
+ "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
+ # applies. For example, https://gcr.io/project/image@sha256:foo This field
+ # can be used as a filter in list requests.
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
# in the associated note.
# DockerImage relationship. This image would be produced from a Dockerfile
- # with FROM <DockerImage.Basis in attached Note>.
+ # with FROM <DockerImage.Basis in attached Note>.
"distance": 42, # Output only. The number of layers by which this image differs from the
# associated image basis.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
@@ -1547,9 +1637,6 @@
# This field can be used as a filter in list requests.
},
},
- "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
- # applies. For example, https://gcr.io/project/image@sha256:foo This field
- # can be used as a filter in list requests.
}</pre>
</div>
@@ -1574,6 +1661,17 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ # `GetIamPolicy`.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ #
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+ # rejected.
+ #
+ # Requests for policies with any conditional bindings must specify version 3.
+ # Policies without any conditional bindings may specify any valid value or
+ # leave the field unset.
+ },
}
x__xgafv: string, V1 error format.
@@ -1584,53 +1682,72 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to
- # specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@@ -1644,7 +1761,7 @@
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
+ # account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -1653,120 +1770,78 @@
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
#
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in
- # Common Expression Language syntax.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "location": "A String", # An optional string indicating the location of the expression for error
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
- "title": "A String", # An optional title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
},
],
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:foo@gmail.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "fooservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:bar@gmail.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts foo@gmail.com from DATA_READ logging, and
- # bar@gmail.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:foo@gmail.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # foo@gmail.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -1775,9 +1850,31 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
- "version": 42, # Deprecated.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
}</pre>
</div>
@@ -1826,8 +1923,38 @@
},
"kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This
# field can be used as a filter in list requests.
+ "upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given # A note describing an upgrade.
+ # version. For each package version combination (i.e. bash 4.0, bash 4.1,
+ # bash 4.1.2), there will be a Upgrade Note.
+ "version": { # Version contains structured information about the version of the package. # Required - The version of the package in machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "distributions": [ # Metadata about the upgrade for each specific operating system.
+ { # The Upgrade Distribution represents metadata about the Upgrade for each
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ ],
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"name": "A String", # The name of the note in the form
- # "providers/{provider_id}/notes/{NOTE_ID}"
+ # "projects/{provider_project_id}/notes/{NOTE_ID}"
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability
@@ -1848,11 +1975,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
"package": "A String", # The name of the package where the vulnerability was found.
# This field can be used as a filter in list requests.
@@ -1860,18 +1987,16 @@
# node.js packages etc)
"isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to
# obsolete details.
- "maxAffectedVersion": { # Version contains structured information about the version of the package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "maxAffectedVersion": { # Version contains structured information about the version of the package. # The max version of the package in which the vulnerability exists.
# For a discussion of this in Debian/Ubuntu:
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
"fixedLocation": { # The location of the vulnerability # The fix for this specific package version.
"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
@@ -1883,11 +2008,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
"package": "A String", # The package being described.
},
@@ -1913,11 +2038,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -1953,7 +2078,7 @@
"baseImage": { # Basis describes the base image portion (Note) of the DockerImage # A note describing a base image.
# relationship. Linked occurrences are derived from this or an
# equivalent image via:
- # FROM <Basis.resource_url>
+ # FROM <Basis.resource_url>
# Or an equivalent reference, e.g. a tag of the resource_url.
"resourceUrl": "A String", # The resource_url for the resource representing the basis of
# associated occurrence images.
@@ -2043,6 +2168,61 @@
# results.
"occurrences": [ # The occurrences requested.
{ # `Occurrence` includes information about analysis occurrences for an image.
+ "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
+ # to fix it.
+ "packageIssue": [ # The set of affected locations and their fixes (if available) within
+ # the associated resource.
+ { # This message wraps a location affected by a vulnerability and its
+ # associated fix (if one is available).
+ "severityName": "A String",
+ "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ },
+ ],
+ "type": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cvssScore": 3.14, # 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.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
+ # available and note provider assigned severity when distro has not yet
+ # assigned a severity for this vulnerability.
+ },
"resource": { # #
# The resource for which the `Occurrence` applies.
# Resource is an entity that can have metadata. E.g., a Docker image.
@@ -2050,11 +2230,41 @@
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
+ "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
"uri": "A String", # The unique URI of the resource. E.g.,
# "https://gcr.io/project/image@sha256:foo" for a Docker image.
- "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
},
"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
+ "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
+ # 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).
+ "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
+ # for the resource_url. This allows efficient filtering, as well as
+ # making it easier to use the occurrence.
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
# a system.
"location": [ # All of the places within the filesystem versions of this package
@@ -2070,11 +2280,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -2121,9 +2331,9 @@
# Repository.
"projectId": "A String", # ID of the project that owns the repo.
"branchName": "A String", # Name of the branch to build.
- "repoName": "A String", # Name of the repo.
- "tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
+ "tagName": "A String", # Name of the tag to build.
+ "repoName": "A String", # Name of the repo.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build.
@@ -2152,8 +2362,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -2163,12 +2372,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -2180,10 +2389,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
],
@@ -2192,8 +2401,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -2203,12 +2411,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -2220,10 +2428,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
@@ -2243,7 +2451,7 @@
"creator": "A String", # 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.
- "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
+ "projectId": "A String", # ID of the project.
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"createTime": "A String", # Time at which the build was created.
"builtArtifacts": [ # Output of the build.
@@ -2271,7 +2479,7 @@
],
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"startTime": "A String", # Time at which execution of the build was started.
- "projectId": "A String", # ID of the project.
+ "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
"id": "A String", # Unique identifier of the build.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
@@ -2332,6 +2540,8 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
+ "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "cpe": "A String", # The CPE of the resource being scanned.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
# details to show to the user. The LocalizedMessage output only and
# populated by the API.
@@ -2352,7 +2562,6 @@
},
],
},
- "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
},
"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
# Attestation can be verified using the attached signature. If the verifier
@@ -2377,7 +2586,7 @@
# gpg --with-colons --with-fingerprint --force-v4-certs \
# --list-keys attester@example.com
# tru::1:1513631572:0:3:1:5
- # pub:...<SNIP>...
+ # pub:...<SNIP>...
# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
# ```
# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
@@ -2412,66 +2621,14 @@
"config": "A String", # Configuration used to create this deployment.
},
"remediation": "A String", # A description of actions that can be taken to remedy the `Note`
- "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
- # to fix it.
- "packageIssue": [ # The set of affected locations and their fixes (if available) within
- # the associated resource.
- { # This message wraps a location affected by a vulnerability and its
- # associated fix (if one is available).
- "severityName": "A String",
- "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- },
- ],
- "type": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cvssScore": 3.14, # 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.
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
- # available and note provider assigned severity when distro has not yet
- # assigned a severity for this vulnerability.
- },
+ "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
+ # applies. For example, https://gcr.io/project/image@sha256:foo This field
+ # can be used as a filter in list requests.
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
# in the associated note.
# DockerImage relationship. This image would be produced from a Dockerfile
- # with FROM <DockerImage.Basis in attached Note>.
+ # with FROM <DockerImage.Basis in attached Note>.
"distance": 42, # Output only. The number of layers by which this image differs from the
# associated image basis.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
@@ -2497,9 +2654,6 @@
# This field can be used as a filter in list requests.
},
},
- "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
- # applies. For example, https://gcr.io/project/image@sha256:foo This field
- # can be used as a filter in list requests.
},
],
}</pre>
@@ -2520,16 +2674,71 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing occurrence.
Args:
name: string, The name of the occurrence.
Should be of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # `Occurrence` includes information about analysis occurrences for an image.
+ "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
+ # to fix it.
+ "packageIssue": [ # The set of affected locations and their fixes (if available) within
+ # the associated resource.
+ { # This message wraps a location affected by a vulnerability and its
+ # associated fix (if one is available).
+ "severityName": "A String",
+ "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ },
+ ],
+ "type": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cvssScore": 3.14, # 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.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
+ # available and note provider assigned severity when distro has not yet
+ # assigned a severity for this vulnerability.
+ },
"resource": { # #
# The resource for which the `Occurrence` applies.
# Resource is an entity that can have metadata. E.g., a Docker image.
@@ -2537,11 +2746,41 @@
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
+ "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
"uri": "A String", # The unique URI of the resource. E.g.,
# "https://gcr.io/project/image@sha256:foo" for a Docker image.
- "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
},
"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
+ "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
+ # 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).
+ "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
+ # for the resource_url. This allows efficient filtering, as well as
+ # making it easier to use the occurrence.
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
# a system.
"location": [ # All of the places within the filesystem versions of this package
@@ -2557,11 +2796,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -2608,9 +2847,9 @@
# Repository.
"projectId": "A String", # ID of the project that owns the repo.
"branchName": "A String", # Name of the branch to build.
- "repoName": "A String", # Name of the repo.
- "tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
+ "tagName": "A String", # Name of the tag to build.
+ "repoName": "A String", # Name of the repo.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build.
@@ -2639,8 +2878,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -2650,12 +2888,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -2667,10 +2905,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
],
@@ -2679,8 +2917,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -2690,12 +2927,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -2707,10 +2944,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
@@ -2730,7 +2967,7 @@
"creator": "A String", # 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.
- "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
+ "projectId": "A String", # ID of the project.
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"createTime": "A String", # Time at which the build was created.
"builtArtifacts": [ # Output of the build.
@@ -2758,7 +2995,7 @@
],
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"startTime": "A String", # Time at which execution of the build was started.
- "projectId": "A String", # ID of the project.
+ "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
"id": "A String", # Unique identifier of the build.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
@@ -2819,6 +3056,8 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
+ "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "cpe": "A String", # The CPE of the resource being scanned.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
# details to show to the user. The LocalizedMessage output only and
# populated by the API.
@@ -2839,7 +3078,6 @@
},
],
},
- "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
},
"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
# Attestation can be verified using the attached signature. If the verifier
@@ -2864,7 +3102,7 @@
# gpg --with-colons --with-fingerprint --force-v4-certs \
# --list-keys attester@example.com
# tru::1:1513631572:0:3:1:5
- # pub:...<SNIP>...
+ # pub:...<SNIP>...
# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
# ```
# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
@@ -2899,66 +3137,14 @@
"config": "A String", # Configuration used to create this deployment.
},
"remediation": "A String", # A description of actions that can be taken to remedy the `Note`
- "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
- # to fix it.
- "packageIssue": [ # The set of affected locations and their fixes (if available) within
- # the associated resource.
- { # This message wraps a location affected by a vulnerability and its
- # associated fix (if one is available).
- "severityName": "A String",
- "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- },
- ],
- "type": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cvssScore": 3.14, # 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.
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
- # available and note provider assigned severity when distro has not yet
- # assigned a severity for this vulnerability.
- },
+ "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
+ # applies. For example, https://gcr.io/project/image@sha256:foo This field
+ # can be used as a filter in list requests.
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
# in the associated note.
# DockerImage relationship. This image would be produced from a Dockerfile
- # with FROM <DockerImage.Basis in attached Note>.
+ # with FROM <DockerImage.Basis in attached Note>.
"distance": 42, # Output only. The number of layers by which this image differs from the
# associated image basis.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
@@ -2984,9 +3170,6 @@
# This field can be used as a filter in list requests.
},
},
- "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
- # applies. For example, https://gcr.io/project/image@sha256:foo This field
- # can be used as a filter in list requests.
}
updateMask: string, The fields to update.
@@ -2999,6 +3182,61 @@
An object of the form:
{ # `Occurrence` includes information about analysis occurrences for an image.
+ "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
+ # to fix it.
+ "packageIssue": [ # The set of affected locations and their fixes (if available) within
+ # the associated resource.
+ { # This message wraps a location affected by a vulnerability and its
+ # associated fix (if one is available).
+ "severityName": "A String",
+ "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
+ "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
+ # format. Examples include distro or storage location for vulnerable jar.
+ # This field can be used as a filter in list requests.
+ "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
+ # filter in list requests.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # The package being described.
+ },
+ },
+ ],
+ "type": "A String", # The type of package; whether native or non native(ruby gems,
+ # node.js packages etc)
+ "cvssScore": 3.14, # 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.
+ "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
+ "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
+ # available and note provider assigned severity when distro has not yet
+ # assigned a severity for this vulnerability.
+ },
"resource": { # #
# The resource for which the `Occurrence` applies.
# Resource is an entity that can have metadata. E.g., a Docker image.
@@ -3006,11 +3244,41 @@
"type": "A String", # The type of hash that was performed.
"value": "A String", # The hash value.
},
+ "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
"uri": "A String", # The unique URI of the resource. E.g.,
# "https://gcr.io/project/image@sha256:foo" for a Docker image.
- "name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".
},
"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.
+ "upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a # Describes an upgrade.
+ # 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).
+ "distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each # Metadata about the upgrade for available for the specific operating system
+ # for the resource_url. This allows efficient filtering, as well as
+ # making it easier to use the occurrence.
+ # operating system (CPE). Some distributions have additional metadata around
+ # updates, classifying them into various categories and severities.
+ "cpeUri": "A String", # Required - The specific operating system this metadata applies to. See
+ # https://cpe.mitre.org/specification/.
+ "cve": [ # The cve that would be resolved by this upgrade.
+ "A String",
+ ],
+ "severity": "A String", # The severity as specified by the upstream operating system.
+ "classification": "A String", # The operating system classification of this Upgrade, as specified by the
+ # upstream operating system upgrade feed.
+ },
+ "parsedVersion": { # Version contains structured information about the version of the package. # Required - The version of the package in a machine + human readable form.
+ # For a discussion of this in Debian/Ubuntu:
+ # http://serverfault.com/questions/604541/debian-packages-version-convention
+ # For a discussion of this in Redhat/Fedora/Centos:
+ # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
+ "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
+ # If kind is not NORMAL, then the other fields are ignored.
+ "revision": "A String", # The iteration of the package build from the above version.
+ },
+ "package": "A String", # Required - The package this Upgrade is for.
+ },
"installation": { # This represents how a particular software package may be installed on # Describes the installation of a package on the linked resource.
# a system.
"location": [ # All of the places within the filesystem versions of this package
@@ -3026,11 +3294,11 @@
# http://serverfault.com/questions/604541/debian-packages-version-convention
# For a discussion of this in Redhat/Fedora/Centos:
# http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
+ "epoch": 42, # Used to correct mistakes in the version numbering scheme.
+ "name": "A String", # The main part of the version name.
"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
# If kind is not NORMAL, then the other fields are ignored.
"revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
},
},
],
@@ -3077,9 +3345,9 @@
# Repository.
"projectId": "A String", # ID of the project that owns the repo.
"branchName": "A String", # Name of the branch to build.
- "repoName": "A String", # Name of the repo.
- "tagName": "A String", # Name of the tag to build.
"commitSha": "A String", # Explicit commit SHA to build.
+ "tagName": "A String", # Name of the tag to build.
+ "repoName": "A String", # Name of the repo.
},
"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build.
@@ -3108,8 +3376,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -3119,12 +3386,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -3136,10 +3403,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
],
@@ -3148,8 +3415,7 @@
"git": { # A GitSourceContext denotes a particular revision in a third party Git # A SourceContext referring to any third party Git repo (e.g., GitHub).
# repository (e.g., GitHub).
"url": "A String", # Git repository URL.
- "revisionId": "A String", # Required.
- # Git commit hash.
+ "revisionId": "A String", # Required. Git commit hash.
},
"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud # A SourceContext referring to a revision in a Google Cloud Source Repo.
# Source Repo.
@@ -3159,12 +3425,12 @@
},
"revisionId": "A String", # A revision ID.
"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.
+ "uid": "A String", # A server-assigned, globally unique identifier.
"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., # A combination of a project ID and a repo name.
# winged-cargo-31) and a repo name within that project.
"projectId": "A String", # The ID of the project.
"repoName": "A String", # The name of the repo. Leave empty for the default repo.
},
- "uid": "A String", # A server-assigned, globally unique identifier.
},
},
"labels": { # Labels with user defined metadata.
@@ -3176,10 +3442,10 @@
"name": "A String", # The alias name.
},
"revisionId": "A String", # A revision (commit) ID.
+ "hostUri": "A String", # The URI of a running Gerrit instance.
"gerritProject": "A String", # 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.
- "hostUri": "A String", # The URI of a running Gerrit instance.
},
},
"storageSource": { # StorageSource describes the location of the source in an archive file in # If provided, get the source from this location in in Google Cloud
@@ -3199,7 +3465,7 @@
"creator": "A String", # 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.
- "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
+ "projectId": "A String", # ID of the project.
"builderVersion": "A String", # Version string of the builder at the time this build was executed.
"createTime": "A String", # Time at which the build was created.
"builtArtifacts": [ # Output of the build.
@@ -3227,7 +3493,7 @@
],
"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.
"startTime": "A String", # Time at which execution of the build was started.
- "projectId": "A String", # ID of the project.
+ "logsBucket": "A String", # Google Cloud Storage bucket where logs were written.
"id": "A String", # Unique identifier of the build.
},
"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the
@@ -3288,6 +3554,8 @@
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
+ "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
+ "cpe": "A String", # The CPE of the resource being scanned.
"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for # When an error is encountered this will contain a LocalizedMessage under
# details to show to the user. The LocalizedMessage output only and
# populated by the API.
@@ -3308,7 +3576,6 @@
},
],
},
- "continuousAnalysis": "A String", # Whether the resource is continuously analyzed.
},
"attestation": { # Occurrence that represents a single "attestation". The authenticity of an # Describes an attestation of an artifact.
# Attestation can be verified using the attached signature. If the verifier
@@ -3333,7 +3600,7 @@
# gpg --with-colons --with-fingerprint --force-v4-certs \
# --list-keys attester@example.com
# tru::1:1513631572:0:3:1:5
- # pub:...<SNIP>...
+ # pub:...<SNIP>...
# fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:
# ```
# Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
@@ -3368,66 +3635,14 @@
"config": "A String", # Configuration used to create this deployment.
},
"remediation": "A String", # A description of actions that can be taken to remedy the `Note`
- "vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how # Details of a security vulnerability note.
- # to fix it.
- "packageIssue": [ # The set of affected locations and their fixes (if available) within
- # the associated resource.
- { # This message wraps a location affected by a vulnerability and its
- # associated fix (if one is available).
- "severityName": "A String",
- "affectedLocation": { # The location of the vulnerability # The location of the vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- "fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.
- "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
- # format. Examples include distro or storage location for vulnerable jar.
- # This field can be used as a filter in list requests.
- "version": { # Version contains structured information about the version of the package. # The version of the package being described. This field can be used as a
- # filter in list requests.
- # For a discussion of this in Debian/Ubuntu:
- # http://serverfault.com/questions/604541/debian-packages-version-convention
- # For a discussion of this in Redhat/Fedora/Centos:
- # http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
- "kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions.
- # If kind is not NORMAL, then the other fields are ignored.
- "revision": "A String", # The iteration of the package build from the above version.
- "name": "A String", # The main part of the version name.
- "epoch": 42, # Used to correct mistakes in the version numbering scheme.
- },
- "package": "A String", # The package being described.
- },
- },
- ],
- "type": "A String", # The type of package; whether native or non native(ruby gems,
- # node.js packages etc)
- "cvssScore": 3.14, # 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.
- "severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.
- "effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is
- # available and note provider assigned severity when distro has not yet
- # assigned a severity for this vulnerability.
- },
+ "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
+ # applies. For example, https://gcr.io/project/image@sha256:foo This field
+ # can be used as a filter in list requests.
"createTime": "A String", # Output only. The time this `Occurrence` was created.
"derivedImage": { # Derived describes the derived image portion (Occurrence) of the # Describes how this resource derives from the basis
# in the associated note.
# DockerImage relationship. This image would be produced from a Dockerfile
- # with FROM <DockerImage.Basis in attached Note>.
+ # with FROM <DockerImage.Basis in attached Note>.
"distance": 42, # Output only. The number of layers by which this image differs from the
# associated image basis.
"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image
@@ -3453,14 +3668,11 @@
# This field can be used as a filter in list requests.
},
},
- "resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence`
- # applies. For example, https://gcr.io/project/image@sha256:foo This field
- # can be used as a filter in list requests.
}</pre>
</div>
<div class="method">
- <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on the specified `Note` or `Occurrence`.
Requires `containeranalysis.notes.setIamPolicy` or
`containeranalysis.occurrences.setIamPolicy` permission if the resource is
@@ -3477,60 +3689,79 @@
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
# might reject them.
- # specify access control policies for Cloud Platform resources.
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@@ -3544,7 +3775,7 @@
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
+ # account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -3553,120 +3784,78 @@
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
#
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in
- # Common Expression Language syntax.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "location": "A String", # An optional string indicating the location of the expression for error
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
- "title": "A String", # An optional title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
},
],
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:foo@gmail.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "fooservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:bar@gmail.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts foo@gmail.com from DATA_READ logging, and
- # bar@gmail.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:foo@gmail.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # foo@gmail.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -3675,15 +3864,32 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
- "version": 42, # Deprecated.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- # the fields in the mask will be modified. If no mask is provided, the
- # following default mask is used:
- # paths: "bindings, etag"
- # This field is only used by Cloud IAM.
}
x__xgafv: string, V1 error format.
@@ -3694,53 +3900,72 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to
- # specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
"role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
@@ -3754,7 +3979,7 @@
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
+ # account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
@@ -3763,120 +3988,78 @@
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
# NOTE: An unsatisfied condition will not allow user access via current
# binding. Different bindings, including their conditions, are examined
# independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
#
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "description": "A String", # An optional description of the expression. This is a longer text which
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in
- # Common Expression Language syntax.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "location": "A String", # An optional string indicating the location of the expression for error
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
- "title": "A String", # An optional title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
},
},
],
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:foo@gmail.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "fooservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:bar@gmail.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts foo@gmail.com from DATA_READ logging, and
- # bar@gmail.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:foo@gmail.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # foo@gmail.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -3885,14 +4068,36 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
- "version": 42, # Deprecated.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
}</pre>
</div>
<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns the permissions that a caller has on the specified note or
occurrence resource. Requires list permission on the project (for example,
"storage.objects.list" on the containing bucket for testing permission of
@@ -3905,7 +4110,7 @@
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.