chore: regens API reference docs (#889)
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
index e4678d5..d399823 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
@@ -80,10 +80,10 @@
<p class="firstline">Returns the occurrences Resource.</p>
<p class="toc_element">
- <code><a href="#batchCreate">batchCreate(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates new notes in batch.</p>
<p class="toc_element">
- <code><a href="#create">create(parent, body, noteId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=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>
@@ -95,33 +95,33 @@
<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, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
<p class="firstline">Lists notes for the specified 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 the specified 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="batchCreate">batchCreate(parent, body, x__xgafv=None)</code>
+ <code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
<pre>Creates new notes in batch.
Args:
- parent: string, The name of the project in the form of `projects/[PROJECT_ID]`, under which
+ parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which
the notes are to be created. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request to create notes in batch.
- "notes": { # The notes to create. Max allowed length is 1000.
+ "notes": { # Required. The notes to create. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as
# a filter in list requests.
@@ -185,15 +185,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -218,13 +218,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -247,6 +248,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -276,6 +280,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -307,19 +357,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -414,15 +464,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -447,13 +497,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -476,6 +527,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -505,6 +559,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -536,19 +636,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -572,13 +672,13 @@
</div>
<div class="method">
- <code class="details" id="create">create(parent, body, noteId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, noteId=None, x__xgafv=None)</code>
<pre>Creates a new note.
Args:
- parent: string, The name of the project in the form of `projects/[PROJECT_ID]`, under which
+ parent: string, Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which
the note is to be created. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A type of analysis that can be done for a resource.
@@ -644,15 +744,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -677,13 +777,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -706,6 +807,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -735,6 +839,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -766,19 +916,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -798,7 +948,7 @@
},
}
- noteId: string, The ID to use for this note.
+ noteId: string, Required. The ID to use for this note.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -870,15 +1020,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -903,13 +1053,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -932,6 +1083,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -961,6 +1115,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -992,19 +1192,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -1030,7 +1230,7 @@
<pre>Deletes the specified note.
Args:
- name: string, The name of the note in the form of
+ name: string, Required. The name of the note in the form of
`projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -1057,7 +1257,7 @@
<pre>Gets the specified note.
Args:
- name: string, The name of the note in the form of
+ name: string, Required. The name of the note in the form of
`projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -1130,15 +1330,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -1163,13 +1363,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -1192,6 +1393,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -1221,6 +1425,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -1252,19 +1502,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -1303,6 +1553,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.
@@ -1313,142 +1574,119 @@
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).
- "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.
- },
- ],
- "version": 42, # Deprecated.
- "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`.
+ "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.
+ #
+ # 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.
+ "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", # 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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -1459,7 +1697,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
@@ -1468,33 +1706,32 @@
# * `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.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "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.
- "description": "A String", # An optional description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # An 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.
- },
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
@@ -1505,25 +1742,48 @@
# 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.
+ # **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, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
<pre>Lists notes for the specified project.
Args:
- parent: string, The name of the project to list notes for in the form of
+ parent: string, Required. The name of the project to list notes for in the form of
`projects/[PROJECT_ID]`. (required)
- pageSize: integer, Number of notes to return in the list. Must be positive. Max allowed page
-size is 1000. If not specified, page size defaults to 20.
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. Must be positive. Max allowed page
+size is 1000. If not specified, page size defaults to 20.
filter: string, The filter expression.
Returns:
@@ -1597,15 +1857,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -1630,13 +1890,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -1659,6 +1920,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -1688,6 +1952,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -1719,19 +2029,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -1769,13 +2079,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 the specified note.
Args:
- name: string, The name of the note in the form of
+ name: string, Required. The name of the note in the form of
`projects/[PROVIDER_ID]/notes/[NOTE_ID]`. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A type of analysis that can be done for a resource.
@@ -1841,15 +2151,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -1874,13 +2184,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -1903,6 +2214,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -1932,6 +2246,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -1963,19 +2323,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -2067,15 +2427,15 @@
"attackVector": "A String", # Base Metrics
# Represents the intrinsic characteristics of a vulnerability that are
# constant over time and across user environments.
- "availabilityImpact": "A String",
+ "privilegesRequired": "A String",
"userInteraction": "A String",
"baseScore": 3.14, # The base score is a function of the base metric scores.
- "privilegesRequired": "A String",
+ "availabilityImpact": "A String",
"impactScore": 3.14,
"exploitabilityScore": 3.14,
- "confidentialityImpact": "A String",
- "integrityImpact": "A String",
"scope": "A String",
+ "integrityImpact": "A String",
+ "confidentialityImpact": "A String",
},
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"severity": "A String", # Note provider assigned impact of the vulnerability.
@@ -2100,13 +2460,14 @@
"revision": "A String", # The iteration of the package build from the above version.
},
"package": "A String", # Required. The name of the package where the vulnerability was found.
- "packageType": "A String", # The type of package; whether native or non native(ruby gems, 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 a package. # Deprecated, do not use. Use fixed_location instead.
- #
- # The max version of the package in which the vulnerability exists.
+ "packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js
+ # packages etc).
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
+ "maxAffectedVersion": { # Version contains structured information about the version of a package. # The max version of the package in which the vulnerability exists.
"epoch": 42, # Used to correct mistakes in the version numbering scheme.
"kind": "A String", # Required. Distinguishes between sentinel MIN/MAX versions and normal
# versions.
@@ -2129,6 +2490,9 @@
},
},
],
+ "sourceUpdateTime": "A String", # The time this information was last changed at the source. This is an
+ # upstream timestamp from the underlying information source - e.g. Ubuntu
+ # security tracker.
},
"kind": "A String", # Output only. The type of analysis. This field can be used as a filter in
# list requests.
@@ -2158,6 +2522,52 @@
# example "qa".
},
},
+ "intoto": { # This contains the fields corresponding to the definition of a software supply # A note describing an in-toto link.
+ # chain step in an in-toto layout. This information goes into a Grafeas note.
+ "stepName": "A String", # This field identifies the name of the step in the supply chain.
+ "expectedCommand": [ # This field contains the expected command used to perform the step.
+ "A String",
+ ],
+ "threshold": "A String", # This field contains a value that indicates the minimum number of keys that
+ # need to be used to sign the step's in-toto link.
+ "expectedMaterials": [ # The following fields contain in-toto artifact rules identifying the
+ # artifacts that enter this supply chain step, and exit the supply chain
+ # step, i.e. materials and products of the step.
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "expectedProducts": [
+ { # Defines an object to declare an in-toto artifact rule
+ "artifactRule": [
+ "A String",
+ ],
+ },
+ ],
+ "signingKeys": [ # This field contains the public keys that can be used to verify the
+ # signatures on the step metadata.
+ { # This defines the format used to record keys used in the software supply
+ # chain. An in-toto link is attested using one or more keys defined in the
+ # in-toto layout. An example of this is:
+ # {
+ # "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...",
+ # "key_type": "rsa",
+ # "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B...",
+ # "key_scheme": "rsassa-pss-sha256"
+ # }
+ # The format for in-toto's key definition can be found in section 4.2 of the
+ # in-toto specification.
+ "keyType": "A String", # This field identifies the specific signing method. Eg: "rsa", "ed25519",
+ # and "ecdsa".
+ "keyId": "A String", # key_id is an identifier for the signing key.
+ "publicKeyValue": "A String", # This field contains the actual public key.
+ "keyScheme": "A String", # This field contains the corresponding signature scheme.
+ # Eg: "rsassa-pss-sha256".
+ },
+ ],
+ },
"build": { # Note holding the version of the provider's builder and the signature of the # A note describing build provenance for a verifiable build.
# provenance message in the build details occurrence.
"builderVersion": "A String", # Required. Immutable. Version of the builder which produced this build.
@@ -2189,19 +2599,19 @@
"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", # Required. Immutable. The resource_url for the resource representing the
# basis of associated occurrence images.
"fingerprint": { # A set of properties that uniquely identify a given Docker image. # Required. Immutable. The fingerprint of the base image.
"v1Name": "A String", # Required. The layer ID of the final layer in the Docker image's v1
# representation.
- "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
- # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
- # Only the name of the final blob is kept.
"v2Blob": [ # Required. The ordered list of v2 blobs that represent a given image.
"A String",
],
+ "v2Name": "A String", # Output only. The name of the image's v2 blobs computed via:
+ # [bottom] := v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1])
+ # Only the name of the final blob is kept.
},
},
"expirationTime": "A String", # Time of expiration for this note. Empty if note does not expire.
@@ -2223,7 +2633,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
@@ -2236,149 +2646,126 @@
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).
- "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.
- },
- ],
- "version": 42, # Deprecated.
- "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`.
+ "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.
+ #
+ # 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.
+ "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", # 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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -2389,7 +2776,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
@@ -2398,33 +2785,32 @@
# * `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.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "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.
- "description": "A String", # An optional description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # An 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.
- },
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
@@ -2435,14 +2821,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.
+ # **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.
@@ -2453,142 +2857,119 @@
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).
- "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.
- },
- ],
- "version": 42, # Deprecated.
- "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`.
+ "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.
+ #
+ # 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.
+ "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", # 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.
+ },
"members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
@@ -2599,7 +2980,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
@@ -2608,33 +2989,32 @@
# * `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.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "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.
- "description": "A String", # An optional description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # An 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.
- },
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
@@ -2645,13 +3025,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.
+ # **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. Requires list permission on the project (for example,
`containeranalysis.notes.list`).
@@ -2663,7 +3066,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.