chore: regens API reference docs (#889)
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
index 922ea43..79badc2 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
@@ -80,7 +80,7 @@
<p class="firstline">Returns the occurrences Resource.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, name=None, noteId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new `Note`.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -92,29 +92,29 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the access control policy for a note or an `Occurrence` resource.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, name=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
<p class="firstline">Lists all `Notes` for a given project.</p>
<p class="toc_element">
<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 `Note`.</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, noteId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, name=None, noteId=None, x__xgafv=None)</code>
<pre>Creates a new `Note`.
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:
{ # Provides a detailed description of a `Note`.
@@ -147,8 +147,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
@@ -169,11 +199,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.
@@ -181,18 +211,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/)
@@ -204,11 +232,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.
},
@@ -234,11 +262,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.
},
},
],
@@ -274,7 +302,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.
@@ -351,8 +379,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
@@ -373,11 +431,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.
@@ -385,18 +443,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/)
@@ -408,11 +464,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.
},
@@ -438,11 +494,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.
},
},
],
@@ -478,7 +534,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.
@@ -586,8 +642,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
@@ -608,11 +694,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.
@@ -620,18 +706,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/)
@@ -643,11 +727,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.
},
@@ -673,11 +757,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.
},
},
],
@@ -713,7 +797,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.
@@ -770,6 +854,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.
@@ -780,53 +875,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`.
@@ -840,7 +954,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
@@ -849,120 +963,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
@@ -971,14 +1043,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="list">list(parent, name=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(parent, name=None, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
<pre>Lists all `Notes` for a given project.
Args:
@@ -986,12 +1080,12 @@
name: string, The name field will contain the project Id for example:
"providers/{provider_id}
@Deprecated
- pageSize: integer, Number of notes to return in the list.
pageToken: string, Token to provide to skip to a particular spot in the list.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Number of notes to return in the list.
filter: string, The filter expression.
Returns:
@@ -1031,8 +1125,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
@@ -1053,11 +1177,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.
@@ -1065,18 +1189,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/)
@@ -1088,11 +1210,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.
},
@@ -1118,11 +1240,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.
},
},
],
@@ -1158,7 +1280,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.
@@ -1211,13 +1333,13 @@
</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 `Note`.
Args:
name: string, The name of the note.
Should be of the form "projects/{provider_id}/notes/{note_id}". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Provides a detailed description of a `Note`.
@@ -1250,8 +1372,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
@@ -1272,11 +1424,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.
@@ -1284,18 +1436,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/)
@@ -1307,11 +1457,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.
},
@@ -1337,11 +1487,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.
},
},
],
@@ -1377,7 +1527,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.
@@ -1451,8 +1601,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
@@ -1473,11 +1653,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.
@@ -1485,18 +1665,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/)
@@ -1508,11 +1686,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.
},
@@ -1538,11 +1716,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.
},
},
],
@@ -1578,7 +1756,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.
@@ -1615,7 +1793,7 @@
</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
@@ -1632,60 +1810,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`.
@@ -1699,7 +1896,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
@@ -1708,120 +1905,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
@@ -1830,15 +1985,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.
@@ -1849,53 +2021,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`.
@@ -1909,7 +2100,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
@@ -1918,120 +2109,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
@@ -2040,14 +2189,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
@@ -2060,7 +2231,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.