Blame - docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, name=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

82

<p class="firstline">Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

85

<p class="firstline">Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Returns the requested `Occurrence`.</p>

89

90

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<p class="firstline">Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

93

<code><a href="#getNotes">getNotes(name, x__xgafv=None)</a></code></p>

94

<p class="firstline">Gets the `Note` attached to the given `Occurrence`.</p>

95

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

96

<code><a href="#getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Gets a summary of the number and severity of occurrences.</p>

98

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

99

<code><a href="#list">list(parent, pageToken=None, filter=None, kind=None, name=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

100

<p class="firstline">Lists active `Occurrences` for a given project matching the filters.</p>

101

102

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

103

<p class="firstline">Retrieves the next page of results.</p>

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<p class="firstline">Updates an existing occurrence.</p>

107

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

109

<p class="firstline">Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

111

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

112

<p class="firstline">Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<h3>Method Details</h3>

114

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

115

<code class="details" id="close">close()</code>

116

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

120

<code class="details" id="create">create(parent, body=None, name=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

<pre>Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

122

123

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

parent: string, This field contains the project Id for example: "projects/{project_id}" (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

125

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

126

The object takes the form of:

127

128

{ # `Occurrence` includes information about analysis occurrences for an image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

129

"noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

130

"name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

131

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

132

"address": "A String", # Address of the runtime element hosting this deployment.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

133

"deployTime": "A String", # Beginning of the lifetime of this deployment.

134

"platform": "A String", # Platform hosting this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

135

"userEmail": "A String", # Identity of the user that triggered this deployment.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

136

"config": "A String", # Configuration used to create this deployment.

137

"undeployTime": "A String", # End of the lifetime of this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

138

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

139

"A String",

140

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

141

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

142

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.

143

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

144

{ # Layer holds metadata specific to a layer of a Docker image.

145

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

146

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

147

},

148

],

149

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

150

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

151

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

152

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

153

"A String",

154

],

155

"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. This field can be used as a filter in list requests.

156

},

157

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

158

},

159

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note.

160

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

161

"packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource.

162

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

163

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

164

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

165

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

166

"revision": "A String", # The iteration of the package build from the above version.

167

"name": "A String", # The main part of the version name.

168

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

169

},

170

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

171

"package": "A String", # The package being described.

172

},

173

"severityName": "A String",

174

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

175

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

176

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

177

"revision": "A String", # The iteration of the package build from the above version.

178

"name": "A String", # The main part of the version name.

179

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

180

},

181

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

182

"package": "A String", # The package being described.

},

},

],

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

187

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

188

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

189

},

190

"resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies.

191

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

192

"type": "A String", # The type of hash that was performed.

193

"value": "A String", # The hash value.

194

},

195

"uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image.

196

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

197

},

198

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact.

199

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.

200

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

201

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

202

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

203

},

204

},

205

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

206

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

207

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

208

"installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource.

209

"location": [ # All of the places within the filesystem versions of this package have been found.

210

{ # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

211

"path": "A String", # The path from which we gathered that this package/version is installed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

212

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location.

213

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

214

"revision": "A String", # The iteration of the package build from the above version.

215

"name": "A String", # The main part of the version name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

216

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

217

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

218

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

219

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

220

],

221

"name": "A String", # Output only. The name of the installed package.

222

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

223

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

224

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

225

"projectId": "A String", # ID of the project.

226

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

227

"commands": [ # Commands requested by the build.

228

{ # Command describes a step performed as part of the build pipeline.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

229

"dir": "A String", # Working directory (relative to project source root) used when running this Command.

230

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

231

"A String",

232

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

233

"args": [ # Command-line arguments used when executing this Command.

234

"A String",

235

],

236

"env": [ # Environment variables set before running this Command.

237

"A String",

238

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

239

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

240

"name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

241

},

242

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

243

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

244

"startTime": "A String", # Time at which execution of the build was started.

245

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

246

"finishTime": "A String", # Time at which execution of the build was finished.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

247

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

248

"a_key": "A String",

249

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

250

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

251

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

252

"storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

253

"generation": "A String", # Google Cloud Storage generation for the object.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

254

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

255

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

256

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

257

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

258

{ # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

259

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

260

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

261

"revisionId": "A String", # Required. Git commit hash.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

262

},

263

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

264

"revisionId": "A String", # A revision (commit) ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

265

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

266

"name": "A String", # The alias name.

267

"kind": "A String", # The alias kind.

268

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

269

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

270

"hostUri": "A String", # The URI of a running Gerrit instance.

271

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

272

"labels": { # Labels with user defined metadata.

273

"a_key": "A String",

274

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

275

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

276

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

277

"uid": "A String", # A server-assigned, globally unique identifier.

278

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

279

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

280

"projectId": "A String", # The ID of the project.

281

},

282

},

283

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

284

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

285

"name": "A String", # The alias name.

286

"kind": "A String", # The alias kind.

287

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

288

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

289

},

290

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

291

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

292

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

293

"url": "A String", # Git repository URL.

294

"revisionId": "A String", # Required. Git commit hash.

295

},

296

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

297

"revisionId": "A String", # A revision (commit) ID.

298

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

299

"name": "A String", # The alias name.

300

"kind": "A String", # The alias kind.

301

},

302

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

303

"hostUri": "A String", # The URI of a running Gerrit instance.

304

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

305

"labels": { # Labels with user defined metadata.

306

"a_key": "A String",

307

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

308

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

309

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

310

"uid": "A String", # A server-assigned, globally unique identifier.

311

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

312

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

313

"projectId": "A String", # The ID of the project.

314

},

315

},

316

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

317

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

318

"name": "A String", # The alias name.

319

"kind": "A String", # The alias kind.

320

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

321

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

322

},

323

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo.

324

"repoName": "A String", # Name of the repo.

325

"tagName": "A String", # Name of the tag to build.

326

"branchName": "A String", # Name of the branch to build.

327

"projectId": "A String", # ID of the project that owns the repo.

328

"commitSha": "A String", # Explicit commit SHA to build.

329

},

330

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location.

331

"generation": "A String", # Google Cloud Storage generation for the object.

332

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

333

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

334

},

335

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

336

"a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

337

"fileHash": [ # Collection of file hashes.

338

{ # Container message for hash values.

339

"type": "A String", # The type of hash that was performed.

340

"value": "A String", # The hash value.

},

],

},

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

345

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

346

"builtArtifacts": [ # Output of the build.

347

{ # Artifact describes a build product.

348

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

349

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456

350

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

351

"A String",

352

],

353

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto.

354

},

355

],

356

"id": "A String", # Unique identifier of the build.

357

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

358

},

359

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

360

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

361

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade.

362

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

363

"cve": [ # The cve that would be resolved by this upgrade.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

364

"A String",

365

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

366

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

367

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

368

"severity": "A String", # The severity as specified by the upstream operating system.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

369

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

370

"package": "A String", # Required - The package this Upgrade is for.

371

"parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form.

372

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

373

"revision": "A String", # The iteration of the package build from the above version.

374

"name": "A String", # The main part of the version name.

375

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

376

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

377

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

378

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

379

"analysisStatus": "A String", # The status of discovery for the resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

380

"operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

381

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

382

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

383

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

384

{

385

"a_key": "", # Properties of the object. Contains field @type with type URL.

386

},

387

],

388

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

389

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

390

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

391

"a_key": "", # Properties of the object. Contains field @type with type URL.

392

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

393

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

394

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

395

"a_key": "", # Properties of the object. Contains field @type with type URL.

396

},

397

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

398

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

399

"cpe": "A String", # The CPE of the resource being scanned.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

400

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

401

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API.

402

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

403

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

404

{

405

"a_key": "", # Properties of the object. Contains field @type with type URL.

406

},

407

],

408

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

409

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

410

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

411

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests.

412

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

413

}

414

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

415

name: string, The name of the project. Should be of the form "projects/{project_id}". @Deprecated

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

416

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

423

424

{ # `Occurrence` includes information about analysis occurrences for an image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

425

"noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

426

"name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

427

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

428

"address": "A String", # Address of the runtime element hosting this deployment.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

429

"deployTime": "A String", # Beginning of the lifetime of this deployment.

430

"platform": "A String", # Platform hosting this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

431

"userEmail": "A String", # Identity of the user that triggered this deployment.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

432

"config": "A String", # Configuration used to create this deployment.

433

"undeployTime": "A String", # End of the lifetime of this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

434

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

435

"A String",

436

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

437

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

438

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.

439

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

440

{ # Layer holds metadata specific to a layer of a Docker image.

441

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

442

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

443

},

444

],

445

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

446

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

447

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

448

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

449

"A String",

450

],

451

"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. This field can be used as a filter in list requests.

452

},

453

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

454

},

455

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note.

456

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

457

"packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource.

458

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

459

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

460

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

461

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

462

"revision": "A String", # The iteration of the package build from the above version.

463

"name": "A String", # The main part of the version name.

464

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

465

},

466

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

467

"package": "A String", # The package being described.

468

},

469

"severityName": "A String",

470

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

471

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

472

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

473

"revision": "A String", # The iteration of the package build from the above version.

474

"name": "A String", # The main part of the version name.

475

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

476

},

477

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

478

"package": "A String", # The package being described.

},

},

],

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

483

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

484

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

485

},

486

"resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies.

487

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

488

"type": "A String", # The type of hash that was performed.

489

"value": "A String", # The hash value.

490

},

491

"uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image.

492

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

493

},

494

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact.

495

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.

496

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

497

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

498

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

499

},

500

},

501

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

502

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

503

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

504

"installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource.

505

"location": [ # All of the places within the filesystem versions of this package have been found.

506

{ # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

507

"path": "A String", # The path from which we gathered that this package/version is installed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

508

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location.

509

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

510

"revision": "A String", # The iteration of the package build from the above version.

511

"name": "A String", # The main part of the version name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

512

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

513

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

514

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

515

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

516

],

517

"name": "A String", # Output only. The name of the installed package.

518

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

519

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

520

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

521

"projectId": "A String", # ID of the project.

522

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

523

"commands": [ # Commands requested by the build.

524

{ # Command describes a step performed as part of the build pipeline.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

525

"dir": "A String", # Working directory (relative to project source root) used when running this Command.

526

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

527

"A String",

528

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

529

"args": [ # Command-line arguments used when executing this Command.

530

"A String",

531

],

532

"env": [ # Environment variables set before running this Command.

533

"A String",

534

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

535

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

536

"name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

537

},

538

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

539

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

540

"startTime": "A String", # Time at which execution of the build was started.

541

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

542

"finishTime": "A String", # Time at which execution of the build was finished.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

543

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

544

"a_key": "A String",

545

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

546

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

547

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

548

"storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

549

"generation": "A String", # Google Cloud Storage generation for the object.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

550

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

551

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

552

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

553

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

554

{ # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

555

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

556

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

557

"revisionId": "A String", # Required. Git commit hash.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

558

},

559

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

560

"revisionId": "A String", # A revision (commit) ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

561

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

562

"name": "A String", # The alias name.

563

"kind": "A String", # The alias kind.

564

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

565

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

566

"hostUri": "A String", # The URI of a running Gerrit instance.

567

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

568

"labels": { # Labels with user defined metadata.

569

"a_key": "A String",

570

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

571

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

572

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

573

"uid": "A String", # A server-assigned, globally unique identifier.

574

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

575

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

576

"projectId": "A String", # The ID of the project.

577

},

578

},

579

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

580

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

581

"name": "A String", # The alias name.

582

"kind": "A String", # The alias kind.

583

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

584

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

585

},

586

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

587

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

588

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

589

"url": "A String", # Git repository URL.

590

"revisionId": "A String", # Required. Git commit hash.

591

},

592

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

593

"revisionId": "A String", # A revision (commit) ID.

594

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

595

"name": "A String", # The alias name.

596

"kind": "A String", # The alias kind.

597

},

598

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

599

"hostUri": "A String", # The URI of a running Gerrit instance.

600

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

601

"labels": { # Labels with user defined metadata.

602

"a_key": "A String",

603

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

604

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

605

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

606

"uid": "A String", # A server-assigned, globally unique identifier.

607

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

608

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

609

"projectId": "A String", # The ID of the project.

610

},

611

},

612

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

613

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

614

"name": "A String", # The alias name.

615

"kind": "A String", # The alias kind.

616

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

617

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

618

},

619

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo.

620

"repoName": "A String", # Name of the repo.

621

"tagName": "A String", # Name of the tag to build.

622

"branchName": "A String", # Name of the branch to build.

623

"projectId": "A String", # ID of the project that owns the repo.

624

"commitSha": "A String", # Explicit commit SHA to build.

625

},

626

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location.

627

"generation": "A String", # Google Cloud Storage generation for the object.

628

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

629

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

630

},

631

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

632

"a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

633

"fileHash": [ # Collection of file hashes.

634

{ # Container message for hash values.

635

"type": "A String", # The type of hash that was performed.

636

"value": "A String", # The hash value.

},

],

},

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

641

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

642

"builtArtifacts": [ # Output of the build.

643

{ # Artifact describes a build product.

644

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

645

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456

646

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

647

"A String",

648

],

649

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto.

650

},

651

],

652

"id": "A String", # Unique identifier of the build.

653

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

654

},

655

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

656

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

657

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade.

658

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

659

"cve": [ # The cve that would be resolved by this upgrade.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

660

"A String",

661

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

662

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

663

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

664

"severity": "A String", # The severity as specified by the upstream operating system.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

665

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

666

"package": "A String", # Required - The package this Upgrade is for.

667

"parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form.

668

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

669

"revision": "A String", # The iteration of the package build from the above version.

670

"name": "A String", # The main part of the version name.

671

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

672

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

673

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

674

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

675

"analysisStatus": "A String", # The status of discovery for the resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

676

"operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

677

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

678

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

679

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

680

{

681

"a_key": "", # Properties of the object. Contains field @type with type URL.

682

},

683

],

684

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

685

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

686

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

687

"a_key": "", # Properties of the object. Contains field @type with type URL.

688

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

689

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

690

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

691

"a_key": "", # Properties of the object. Contains field @type with type URL.

692

},

693

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

694

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

695

"cpe": "A String", # The CPE of the resource being scanned.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

696

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

697

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API.

698

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

699

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

700

{

701

"a_key": "", # Properties of the object. Contains field @type with type URL.

702

},

703

],

704

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

705

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

706

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

707

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests.

708

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

714

<pre>Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

715

716

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

717

name: string, The name of the occurrence in the form of "projects/{project_id}/occurrences/{OCCURRENCE_ID}" (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

718

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

725

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

726

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

732

<pre>Returns the requested `Occurrence`.

733

734

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

735

name: string, The name of the occurrence of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

736

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

743

744

{ # `Occurrence` includes information about analysis occurrences for an image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

745

"noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

746

"name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

747

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

748

"address": "A String", # Address of the runtime element hosting this deployment.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

749

"deployTime": "A String", # Beginning of the lifetime of this deployment.

750

"platform": "A String", # Platform hosting this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

751

"userEmail": "A String", # Identity of the user that triggered this deployment.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

752

"config": "A String", # Configuration used to create this deployment.

753

"undeployTime": "A String", # End of the lifetime of this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

754

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

755

"A String",

756

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

757

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

758

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.

759

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

760

{ # Layer holds metadata specific to a layer of a Docker image.

761

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

762

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

763

},

764

],

765

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

766

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

767

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

768

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

769

"A String",

770

],

771

"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. This field can be used as a filter in list requests.

772

},

773

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

774

},

775

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note.

776

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

777

"packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource.

778

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

779

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

780

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

781

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

782

"revision": "A String", # The iteration of the package build from the above version.

783

"name": "A String", # The main part of the version name.

784

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

785

},

786

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

787

"package": "A String", # The package being described.

788

},

789

"severityName": "A String",

790

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

791

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

792

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

793

"revision": "A String", # The iteration of the package build from the above version.

794

"name": "A String", # The main part of the version name.

795

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

796

},

797

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

798

"package": "A String", # The package being described.

},

},

],

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

803

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

804

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

805

},

806

"resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies.

807

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

808

"type": "A String", # The type of hash that was performed.

809

"value": "A String", # The hash value.

810

},

811

"uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image.

812

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

813

},

814

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact.

815

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.

816

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

817

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

818

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

819

},

820

},

821

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

822

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

823

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

824

"installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource.

825

"location": [ # All of the places within the filesystem versions of this package have been found.

826

{ # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

827

"path": "A String", # The path from which we gathered that this package/version is installed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

828

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location.

829

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

830

"revision": "A String", # The iteration of the package build from the above version.

831

"name": "A String", # The main part of the version name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

832

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

833

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

834

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

835

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

836

],

837

"name": "A String", # Output only. The name of the installed package.

838

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

839

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

840

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

841

"projectId": "A String", # ID of the project.

842

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

843

"commands": [ # Commands requested by the build.

844

{ # Command describes a step performed as part of the build pipeline.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

845

"dir": "A String", # Working directory (relative to project source root) used when running this Command.

846

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

847

"A String",

848

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

849

"args": [ # Command-line arguments used when executing this Command.

850

"A String",

851

],

852

"env": [ # Environment variables set before running this Command.

853

"A String",

854

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

855

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

856

"name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

857

},

858

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

859

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

860

"startTime": "A String", # Time at which execution of the build was started.

861

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

862

"finishTime": "A String", # Time at which execution of the build was finished.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

863

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

864

"a_key": "A String",

865

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

866

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

867

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

868

"storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

869

"generation": "A String", # Google Cloud Storage generation for the object.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

870

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

871

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

872

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

873

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

874

{ # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

875

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

876

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

877

"revisionId": "A String", # Required. Git commit hash.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

878

},

879

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

880

"revisionId": "A String", # A revision (commit) ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

881

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

882

"name": "A String", # The alias name.

883

"kind": "A String", # The alias kind.

884

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

885

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

886

"hostUri": "A String", # The URI of a running Gerrit instance.

887

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

888

"labels": { # Labels with user defined metadata.

889

"a_key": "A String",

890

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

891

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

892

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

893

"uid": "A String", # A server-assigned, globally unique identifier.

894

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

895

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

896

"projectId": "A String", # The ID of the project.

897

},

898

},

899

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

900

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

901

"name": "A String", # The alias name.

902

"kind": "A String", # The alias kind.

903

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

904

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

905

},

906

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

907

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

908

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

909

"url": "A String", # Git repository URL.

910

"revisionId": "A String", # Required. Git commit hash.

911

},

912

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

913

"revisionId": "A String", # A revision (commit) ID.

914

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

915

"name": "A String", # The alias name.

916

"kind": "A String", # The alias kind.

917

},

918

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

919

"hostUri": "A String", # The URI of a running Gerrit instance.

920

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

921

"labels": { # Labels with user defined metadata.

922

"a_key": "A String",

923

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

924

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

925

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

926

"uid": "A String", # A server-assigned, globally unique identifier.

927

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

928

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

929

"projectId": "A String", # The ID of the project.

930

},

931

},

932

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

933

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

934

"name": "A String", # The alias name.

935

"kind": "A String", # The alias kind.

936

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

937

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

938

},

939

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo.

940

"repoName": "A String", # Name of the repo.

941

"tagName": "A String", # Name of the tag to build.

942

"branchName": "A String", # Name of the branch to build.

943

"projectId": "A String", # ID of the project that owns the repo.

944

"commitSha": "A String", # Explicit commit SHA to build.

945

},

946

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location.

947

"generation": "A String", # Google Cloud Storage generation for the object.

948

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

949

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

950

},

951

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

952

"a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

953

"fileHash": [ # Collection of file hashes.

954

{ # Container message for hash values.

955

"type": "A String", # The type of hash that was performed.

956

"value": "A String", # The hash value.

},

],

},

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

961

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

962

"builtArtifacts": [ # Output of the build.

963

{ # Artifact describes a build product.

964

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

965

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456

966

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

967

"A String",

968

],

969

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto.

970

},

971

],

972

"id": "A String", # Unique identifier of the build.

973

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

974

},

975

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

976

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

977

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade.

978

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

979

"cve": [ # The cve that would be resolved by this upgrade.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

980

"A String",

981

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

982

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

983

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

984

"severity": "A String", # The severity as specified by the upstream operating system.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

985

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

986

"package": "A String", # Required - The package this Upgrade is for.

987

"parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form.

988

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

989

"revision": "A String", # The iteration of the package build from the above version.

990

"name": "A String", # The main part of the version name.

991

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

992

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

993

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

994

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

995

"analysisStatus": "A String", # The status of discovery for the resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

996

"operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

997

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

998

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

999

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1000

{

1001

"a_key": "", # Properties of the object. Contains field @type with type URL.

1002

},

1003

],

1004

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1005

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1006

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1007

"a_key": "", # Properties of the object. Contains field @type with type URL.

1008

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1009

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1010

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1011

"a_key": "", # Properties of the object. Contains field @type with type URL.

1012

},

1013

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1014

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1015

"cpe": "A String", # The CPE of the resource being scanned.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1016

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

1017

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API.

1018

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1019

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1020

{

1021

"a_key": "", # Properties of the object. Contains field @type with type URL.

1022

},

1023

],

1024

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1025

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1026

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1027

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests.

1028

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1034

<pre>Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1035

1036

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1037

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1038

body: object, The request body.

1039

The object takes the form of:

1040

1041

{ # Request message for `GetIamPolicy` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1042

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.

1043

"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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1044

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1045

}

1046

1047

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1054

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1055

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. 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. For some types of Google Cloud resources, a `binding` can also 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.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:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - 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 documentation](https://cloud.google.com/iam/docs/).

1056

"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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1057

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1058

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1059

"condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1060

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1061

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1062

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1063

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1064

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1065

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone 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@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `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`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1066

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1067

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1068

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1069

},

1070

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1071

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and 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. **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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getNotes">getNotes(name, x__xgafv=None)</code>

1077

<pre>Gets the `Note` attached to the given `Occurrence`.

1078

1079

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1080

name: string, The name of the occurrence in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}" (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1081

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1088

1089

{ # Provides a detailed description of a `Note`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1090

"deployable": { # An artifact that can be deployed in some runtime. # A note describing something that can be deployed.

1091

"resourceUri": [ # Resource URI for the artifact being deployed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1092

"A String",

1093

],

1094

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1095

"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.

1096

"expirationTime": "A String", # Time of expiration for this note, null if note does not expire.

1097

"longDescription": "A String", # A detailed description of this `Note`.

1098

"name": "A String", # The name of the note in the form "projects/{provider_project_id}/notes/{NOTE_ID}"

1099

"createTime": "A String", # Output only. The time this note was created. This field can be used as a filter in list requests.

1100

"discovery": { # A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. # A note describing a provider/analysis type.

1101

"analysisKind": "A String", # The kind of analysis that is handled by this discovery.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

1102

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1103

"upgrade": { # An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be a Upgrade Note. # A note describing an upgrade.

1104

"distributions": [ # Metadata about the upgrade for each specific operating system.

1105

{ # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities.

1106

"cve": [ # The cve that would be resolved by this upgrade.

1107

"A String",

1108

],

1109

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

1110

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

1111

"severity": "A String", # The severity as specified by the upstream operating system.

1112

},

1113

],

1114

"package": "A String", # Required - The package this Upgrade is for.

1115

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in machine + human readable form.

1116

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1117

"revision": "A String", # The iteration of the package build from the above version.

1118

"name": "A String", # The main part of the version name.

1119

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1120

},

1121

},

1122

"relatedUrl": [ # URLs associated with this note

1123

{ # Metadata for any related URL information

1124

"url": "A String", # Specific URL to associate with the note

1125

"label": "A String", # Label to describe usage of the URL

1126

},

1127

],

1128

"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.

1129

"severity": "A String", # Note provider assigned impact of the vulnerability

1130

"details": [ # All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.

1131

{ # Identifies all occurrences of this vulnerability in the package for a specific distro/location For example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2

1132

"package": "A String", # The name of the package where the vulnerability was found. This field can be used as a filter in list requests.

1133

"isObsolete": True or False, # Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details.

1134

"severityName": "A String", # The severity (eg: distro assigned severity) for this vulnerability.

1135

"fixedLocation": { # The location of the vulnerability # The fix for this specific package version.

1136

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1137

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1138

"revision": "A String", # The iteration of the package build from the above version.

1139

"name": "A String", # The main part of the version name.

1140

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1141

},

1142

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1143

"package": "A String", # The package being described.

1144

},

1145

"maxAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The max version of the package in which the vulnerability exists.

1146

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1147

"revision": "A String", # The iteration of the package build from the above version.

1148

"name": "A String", # The main part of the version name.

1149

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1150

},

1151

"packageType": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

1152

"description": "A String", # A vendor-specific description of this note.

1153

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability manifests. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1154

"minAffectedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The min version of the package in which the vulnerability exists.

1155

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1156

"revision": "A String", # The iteration of the package build from the above version.

1157

"name": "A String", # The main part of the version name.

1158

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

},

},

],

"cvssScore": 3.14, # The CVSS score for this Vulnerability.

1163

},

1164

"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `AttestationAuthority` for "QA" and one for "build". This Note is intended to act strictly as a grouping mechanism for the attached Occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an Occurrence to a given Note. It also provides a single point of lookup to find all attached Attestation Occurrences, even if they don't all live in the same project. # A note describing an attestation role.

1165

"hint": { # This submessage provides human-readable hints about the purpose of the AttestationAuthority. Because the name of a Note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should NOT be used to look up AttestationAuthorities in security sensitive contexts, such as when looking up Attestations to verify.

1166

"humanReadableName": "A String", # The human readable name of this Attestation Authority, for example "qa".

1167

},

1168

},

1169

"package": { # This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. # A note describing a package hosted by various package managers.

1170

"distribution": [ # The various channels by which a package is distributed.

1171

{ # This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror

1172

"architecture": "A String", # The CPU architecture for which packages in this distribution channel were built

1173

"description": "A String", # The distribution channel-specific description of this package.

1174

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

1175

"url": "A String", # The distribution channel-specific homepage for this package.

1176

"latestVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The latest available version of this package in this distribution channel.

1177

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1178

"revision": "A String", # The iteration of the package build from the above version.

1179

"name": "A String", # The main part of the version name.

1180

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1181

},

1182

"maintainer": "A String", # A freeform string denoting the maintainer of this package.

1183

},

1184

],

1185

"name": "A String", # The name of the package.

1186

},

1187

"baseImage": { # Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g. a tag of the resource_url. # A note describing a base image.

1188

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the base image.

1189

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

1190

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1191

"A String",

1192

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1193

"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. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1194

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1195

"resourceUrl": "A String", # The resource_url for the resource representing the basis of associated occurrence images.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1196

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1197

"buildType": { # Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. # Build provenance type for a verifiable build.

1198

"builderVersion": "A String", # Version of the builder which produced this Note.

1199

"signature": { # Message encapsulating the signature of the verified build. # Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.

1200

"keyType": "A String", # The type of the key, either stored in `public_key` or referenced in `key_id`

1201

"publicKey": "A String", # Public key of the builder which can be used to verify that the related findings are valid and unchanged. If `key_type` is empty, this defaults to PEM encoded public keys. This field may be empty if `key_id` references an external key. For Cloud Build based signatures, this is a PEM encoded public key. To verify the Cloud Build signature, place the contents of this field into a file (public.pem). The signature field is base64-decoded into its binary representation in signature.bin, and the provenance bytes from `BuildDetails` are base64-decoded into a binary representation in signed.bin. OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -signature signature.bin signed.bin`

1202

"keyId": "A String", # An Id for the key used to sign. This could be either an Id for the key stored in `public_key` (such as the Id or fingerprint for a PGP key, or the CN for a cert), or a reference to an external key (such as a reference to a key in Cloud Key Management Service).

1203

"signature": "A String", # Signature of the related `BuildProvenance`, encoded in a base64 string.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1204

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1205

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1206

"shortDescription": "A String", # A one sentence description of this `Note`.

1207

"kind": "A String", # Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.

1208

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1212

<code class="details" id="getVulnerabilitySummary">getVulnerabilitySummary(parent, filter=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1213

<pre>Gets a summary of the number and severity of occurrences.

1214

1215

Args:

1216

parent: string, This contains the project Id for example: projects/{project_id} (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1217

filter: string, The filter expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1218

x__xgafv: string, V1 error format.

1219

Allowed values

1220

1 - v1 error format

1221

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1222

1223

Returns:

1224

An object of the form:

1225

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1226

{ # A summary of how many vulnz occurrences there are per severity type. counts by groups, or if we should have different summary messages like this.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1227

"counts": [ # A map of how many occurrences were found for each severity.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1228

{ # The number of occurrences created for a specific severity.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1229

"severity": "A String", # The severity of the occurrences.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1230

"count": "A String", # The number of occurrences with the severity.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1237

<code class="details" id="list">list(parent, pageToken=None, filter=None, kind=None, name=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1238

<pre>Lists active `Occurrences` for a given project matching the filters.

1239

1240

Args:

1241

parent: string, This contains the project Id for example: projects/{project_id}. (required)

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1242

pageToken: string, Token to provide to skip to a particular spot in the list.

1243

filter: string, The filter expression.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1244

kind: string, The kind of occurrences to filter on.

1245

Allowed values

1246

KIND_UNSPECIFIED - Unknown

1247

PACKAGE_VULNERABILITY - The note and occurrence represent a package vulnerability.

1248

BUILD_DETAILS - The note and occurrence assert build provenance.

1249

IMAGE_BASIS - This represents an image basis relationship.

1250

PACKAGE_MANAGER - This represents a package installed via a package manager.

1251

DEPLOYABLE - The note and occurrence track deployment events.

1252

DISCOVERY - The note and occurrence track the initial discovery status of a resource.

1253

ATTESTATION_AUTHORITY - This represents a logical "role" that can attest to artifacts.

1254

UPGRADE - This represents an available software upgrade.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1255

name: string, The name field contains the project Id. For example: "projects/{project_id} @Deprecated

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1256

pageSize: integer, Number of occurrences to return in the list.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1257

x__xgafv: string, V1 error format.

1258

Allowed values

1259

1 - v1 error format

1260

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1261

1262

Returns:

1263

An object of the form:

1264

1265

{ # Response including listed active occurrences.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1266

"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1267

"occurrences": [ # The occurrences requested.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1268

{ # `Occurrence` includes information about analysis occurrences for an image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1269

"noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1270

"name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1271

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1272

"address": "A String", # Address of the runtime element hosting this deployment.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1273

"deployTime": "A String", # Beginning of the lifetime of this deployment.

1274

"platform": "A String", # Platform hosting this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1275

"userEmail": "A String", # Identity of the user that triggered this deployment.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1276

"config": "A String", # Configuration used to create this deployment.

1277

"undeployTime": "A String", # End of the lifetime of this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1278

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

1279

"A String",

1280

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1281

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1282

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.

1283

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

1284

{ # Layer holds metadata specific to a layer of a Docker image.

1285

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

1286

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

1287

},

1288

],

1289

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

1290

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

1291

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

1292

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

1293

"A String",

1294

],

1295

"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. This field can be used as a filter in list requests.

1296

},

1297

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

1298

},

1299

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note.

1300

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

1301

"packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource.

1302

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

1303

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

1304

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1305

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1306

"revision": "A String", # The iteration of the package build from the above version.

1307

"name": "A String", # The main part of the version name.

1308

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1309

},

1310

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1311

"package": "A String", # The package being described.

1312

},

1313

"severityName": "A String",

1314

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

1315

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1316

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1317

"revision": "A String", # The iteration of the package build from the above version.

1318

"name": "A String", # The main part of the version name.

1319

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1320

},

1321

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1322

"package": "A String", # The package being described.

},

},

],

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

1327

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

1328

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

1329

},

1330

"resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies.

1331

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

1332

"type": "A String", # The type of hash that was performed.

1333

"value": "A String", # The hash value.

1334

},

1335

"uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image.

1336

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

1337

},

1338

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact.

1339

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.

1340

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1341

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

1342

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

1343

},

1344

},

1345

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1346

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1347

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1348

"installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource.

1349

"location": [ # All of the places within the filesystem versions of this package have been found.

1350

{ # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1351

"path": "A String", # The path from which we gathered that this package/version is installed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1352

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location.

1353

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1354

"revision": "A String", # The iteration of the package build from the above version.

1355

"name": "A String", # The main part of the version name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1356

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1357

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1358

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1359

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1360

],

1361

"name": "A String", # Output only. The name of the installed package.

1362

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1363

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

1364

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1365

"projectId": "A String", # ID of the project.

1366

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1367

"commands": [ # Commands requested by the build.

1368

{ # Command describes a step performed as part of the build pipeline.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1369

"dir": "A String", # Working directory (relative to project source root) used when running this Command.

1370

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

1371

"A String",

1372

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1373

"args": [ # Command-line arguments used when executing this Command.

1374

"A String",

1375

],

1376

"env": [ # Environment variables set before running this Command.

1377

"A String",

1378

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1379

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1380

"name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

1381

},

1382

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1383

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

1384

"startTime": "A String", # Time at which execution of the build was started.

1385

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

1386

"finishTime": "A String", # Time at which execution of the build was finished.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1387

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

1388

"a_key": "A String",

1389

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1390

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1391

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1392

"storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1393

"generation": "A String", # Google Cloud Storage generation for the object.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1394

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1395

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1396

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1397

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

1398

{ # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1399

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1400

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1401

"revisionId": "A String", # Required. Git commit hash.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1402

},

1403

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1404

"revisionId": "A String", # A revision (commit) ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1405

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1406

"name": "A String", # The alias name.

1407

"kind": "A String", # The alias kind.

1408

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1409

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1410

"hostUri": "A String", # The URI of a running Gerrit instance.

1411

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1412

"labels": { # Labels with user defined metadata.

1413

"a_key": "A String",

1414

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1415

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1416

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

1417

"uid": "A String", # A server-assigned, globally unique identifier.

1418

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

1419

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

1420

"projectId": "A String", # The ID of the project.

1421

},

1422

},

1423

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1424

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1425

"name": "A String", # The alias name.

1426

"kind": "A String", # The alias kind.

1427

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1428

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1429

},

1430

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1431

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

1432

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

1433

"url": "A String", # Git repository URL.

1434

"revisionId": "A String", # Required. Git commit hash.

1435

},

1436

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

1437

"revisionId": "A String", # A revision (commit) ID.

1438

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1439

"name": "A String", # The alias name.

1440

"kind": "A String", # The alias kind.

1441

},

1442

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1443

"hostUri": "A String", # The URI of a running Gerrit instance.

1444

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1445

"labels": { # Labels with user defined metadata.

1446

"a_key": "A String",

1447

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1448

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1449

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

1450

"uid": "A String", # A server-assigned, globally unique identifier.

1451

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

1452

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

1453

"projectId": "A String", # The ID of the project.

1454

},

1455

},

1456

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1457

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1458

"name": "A String", # The alias name.

1459

"kind": "A String", # The alias kind.

1460

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1461

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1462

},

1463

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo.

1464

"repoName": "A String", # Name of the repo.

1465

"tagName": "A String", # Name of the tag to build.

1466

"branchName": "A String", # Name of the branch to build.

1467

"projectId": "A String", # ID of the project that owns the repo.

1468

"commitSha": "A String", # Explicit commit SHA to build.

1469

},

1470

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location.

1471

"generation": "A String", # Google Cloud Storage generation for the object.

1472

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1473

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1474

},

1475

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

1476

"a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

1477

"fileHash": [ # Collection of file hashes.

1478

{ # Container message for hash values.

1479

"type": "A String", # The type of hash that was performed.

1480

"value": "A String", # The hash value.

},

],

},

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1485

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1486

"builtArtifacts": [ # Output of the build.

1487

{ # Artifact describes a build product.

1488

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

1489

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456

1490

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

1491

"A String",

1492

],

1493

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto.

1494

},

1495

],

1496

"id": "A String", # Unique identifier of the build.

1497

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1498

},

1499

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

1500

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1501

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade.

1502

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

1503

"cve": [ # The cve that would be resolved by this upgrade.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1504

"A String",

1505

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1506

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

1507

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

1508

"severity": "A String", # The severity as specified by the upstream operating system.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1509

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1510

"package": "A String", # Required - The package this Upgrade is for.

1511

"parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form.

1512

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1513

"revision": "A String", # The iteration of the package build from the above version.

1514

"name": "A String", # The main part of the version name.

1515

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1516

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1517

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1518

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1519

"analysisStatus": "A String", # The status of discovery for the resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1520

"operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1521

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1522

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1523

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1524

{

1525

"a_key": "", # Properties of the object. Contains field @type with type URL.

1526

},

1527

],

1528

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1529

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1530

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1531

"a_key": "", # Properties of the object. Contains field @type with type URL.

1532

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1533

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1534

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1535

"a_key": "", # Properties of the object. Contains field @type with type URL.

1536

},

1537

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1538

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1539

"cpe": "A String", # The CPE of the resource being scanned.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1540

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

1541

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API.

1542

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1543

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1544

{

1545

"a_key": "", # Properties of the object. Contains field @type with type URL.

1546

},

1547

],

1548

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1549

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1550

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1551

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests.

1552

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1560

<pre>Retrieves the next page of results.

1561

1562

Args:

1563

previous_request: The request for the previous page. (required)

1564

previous_response: The response from the request for the previous page. (required)

1565

1566

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1567

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1568

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1573

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1574

<pre>Updates an existing occurrence.

1575

1576

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1577

name: string, The name of the occurrence. Should be of the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}". (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1578

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1579

The object takes the form of:

1580

1581

{ # `Occurrence` includes information about analysis occurrences for an image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1582

"noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1583

"name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1584

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1585

"address": "A String", # Address of the runtime element hosting this deployment.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1586

"deployTime": "A String", # Beginning of the lifetime of this deployment.

1587

"platform": "A String", # Platform hosting this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1588

"userEmail": "A String", # Identity of the user that triggered this deployment.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1589

"config": "A String", # Configuration used to create this deployment.

1590

"undeployTime": "A String", # End of the lifetime of this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1591

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

1592

"A String",

1593

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1594

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1595

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.

1596

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

1597

{ # Layer holds metadata specific to a layer of a Docker image.

1598

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

1599

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

1600

},

1601

],

1602

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

1603

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

1604

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

1605

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

1606

"A String",

1607

],

1608

"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. This field can be used as a filter in list requests.

1609

},

1610

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

1611

},

1612

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note.

1613

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

1614

"packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource.

1615

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

1616

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

1617

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1618

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1619

"revision": "A String", # The iteration of the package build from the above version.

1620

"name": "A String", # The main part of the version name.

1621

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1622

},

1623

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1624

"package": "A String", # The package being described.

1625

},

1626

"severityName": "A String",

1627

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

1628

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1629

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1630

"revision": "A String", # The iteration of the package build from the above version.

1631

"name": "A String", # The main part of the version name.

1632

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1633

},

1634

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1635

"package": "A String", # The package being described.

},

},

],

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

1640

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

1641

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

1642

},

1643

"resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies.

1644

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

1645

"type": "A String", # The type of hash that was performed.

1646

"value": "A String", # The hash value.

1647

},

1648

"uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image.

1649

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

1650

},

1651

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact.

1652

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.

1653

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1654

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

1655

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

1656

},

1657

},

1658

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1659

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1660

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1661

"installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource.

1662

"location": [ # All of the places within the filesystem versions of this package have been found.

1663

{ # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1664

"path": "A String", # The path from which we gathered that this package/version is installed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1665

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location.

1666

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1667

"revision": "A String", # The iteration of the package build from the above version.

1668

"name": "A String", # The main part of the version name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1669

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1670

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1671

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1672

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1673

],

1674

"name": "A String", # Output only. The name of the installed package.

1675

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1676

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

1677

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1678

"projectId": "A String", # ID of the project.

1679

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1680

"commands": [ # Commands requested by the build.

1681

{ # Command describes a step performed as part of the build pipeline.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1682

"dir": "A String", # Working directory (relative to project source root) used when running this Command.

1683

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

1684

"A String",

1685

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1686

"args": [ # Command-line arguments used when executing this Command.

1687

"A String",

1688

],

1689

"env": [ # Environment variables set before running this Command.

1690

"A String",

1691

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1692

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1693

"name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

1694

},

1695

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1696

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

1697

"startTime": "A String", # Time at which execution of the build was started.

1698

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

1699

"finishTime": "A String", # Time at which execution of the build was finished.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1700

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

1701

"a_key": "A String",

1702

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1703

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1704

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1705

"storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1706

"generation": "A String", # Google Cloud Storage generation for the object.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1707

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1708

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1709

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1710

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

1711

{ # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1712

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1713

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1714

"revisionId": "A String", # Required. Git commit hash.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1715

},

1716

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1717

"revisionId": "A String", # A revision (commit) ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1718

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1719

"name": "A String", # The alias name.

1720

"kind": "A String", # The alias kind.

1721

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1722

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1723

"hostUri": "A String", # The URI of a running Gerrit instance.

1724

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1725

"labels": { # Labels with user defined metadata.

1726

"a_key": "A String",

1727

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1728

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1729

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

1730

"uid": "A String", # A server-assigned, globally unique identifier.

1731

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

1732

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

1733

"projectId": "A String", # The ID of the project.

1734

},

1735

},

1736

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1737

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1738

"name": "A String", # The alias name.

1739

"kind": "A String", # The alias kind.

1740

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1741

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1742

},

1743

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1744

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

1745

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

1746

"url": "A String", # Git repository URL.

1747

"revisionId": "A String", # Required. Git commit hash.

1748

},

1749

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

1750

"revisionId": "A String", # A revision (commit) ID.

1751

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1752

"name": "A String", # The alias name.

1753

"kind": "A String", # The alias kind.

1754

},

1755

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

1756

"hostUri": "A String", # The URI of a running Gerrit instance.

1757

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1758

"labels": { # Labels with user defined metadata.

1759

"a_key": "A String",

1760

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1761

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1762

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

1763

"uid": "A String", # A server-assigned, globally unique identifier.

1764

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

1765

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

1766

"projectId": "A String", # The ID of the project.

1767

},

1768

},

1769

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1770

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

1771

"name": "A String", # The alias name.

1772

"kind": "A String", # The alias kind.

1773

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1774

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1775

},

1776

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo.

1777

"repoName": "A String", # Name of the repo.

1778

"tagName": "A String", # Name of the tag to build.

1779

"branchName": "A String", # Name of the branch to build.

1780

"projectId": "A String", # ID of the project that owns the repo.

1781

"commitSha": "A String", # Explicit commit SHA to build.

1782

},

1783

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location.

1784

"generation": "A String", # Google Cloud Storage generation for the object.

1785

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

1786

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1787

},

1788

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

1789

"a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

1790

"fileHash": [ # Collection of file hashes.

1791

{ # Container message for hash values.

1792

"type": "A String", # The type of hash that was performed.

1793

"value": "A String", # The hash value.

},

],

},

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1798

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1799

"builtArtifacts": [ # Output of the build.

1800

{ # Artifact describes a build product.

1801

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

1802

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456

1803

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

1804

"A String",

1805

],

1806

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto.

1807

},

1808

],

1809

"id": "A String", # Unique identifier of the build.

1810

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1811

},

1812

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

1813

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1814

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade.

1815

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

1816

"cve": [ # The cve that would be resolved by this upgrade.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1817

"A String",

1818

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1819

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

1820

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

1821

"severity": "A String", # The severity as specified by the upstream operating system.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1822

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1823

"package": "A String", # Required - The package this Upgrade is for.

1824

"parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form.

1825

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1826

"revision": "A String", # The iteration of the package build from the above version.

1827

"name": "A String", # The main part of the version name.

1828

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1829

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1830

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1831

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1832

"analysisStatus": "A String", # The status of discovery for the resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1833

"operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1834

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1835

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1836

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1837

{

1838

"a_key": "", # Properties of the object. Contains field @type with type URL.

1839

},

1840

],

1841

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1842

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1843

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1844

"a_key": "", # Properties of the object. Contains field @type with type URL.

1845

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1846

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1847

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1848

"a_key": "", # Properties of the object. Contains field @type with type URL.

1849

},

1850

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1851

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1852

"cpe": "A String", # The CPE of the resource being scanned.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1853

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

1854

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API.

1855

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1856

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1857

{

1858

"a_key": "", # Properties of the object. Contains field @type with type URL.

1859

},

1860

],

1861

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1862

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1863

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1864

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests.

1865

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1866

}

1867

1868

updateMask: string, The fields to update.

1869

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1876

1877

{ # `Occurrence` includes information about analysis occurrences for an image.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1878

"noteName": "A String", # An analysis note associated with this image, in the form "providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1879

"name": "A String", # Output only. The name of the `Occurrence` in the form "projects/{project_id}/occurrences/{OCCURRENCE_ID}"

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1880

"deployment": { # The period during which some deployable was active in a runtime. # Describes the deployment of an artifact on a runtime.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1881

"address": "A String", # Address of the runtime element hosting this deployment.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1882

"deployTime": "A String", # Beginning of the lifetime of this deployment.

1883

"platform": "A String", # Platform hosting this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1884

"userEmail": "A String", # Identity of the user that triggered this deployment.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1885

"config": "A String", # Configuration used to create this deployment.

1886

"undeployTime": "A String", # End of the lifetime of this deployment.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1887

"resourceUri": [ # Output only. Resource URI for the artifact being deployed taken from the deployable field with the same name.

1888

"A String",

1889

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1890

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1891

"derivedImage": { # Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . # Describes how this resource derives from the basis in the associated note.

1892

"layerInfo": [ # This contains layer-specific metadata, if populated it has length "distance" and is ordered with [distance] being the layer immediately following the base image and [1] being the final layer.

1893

{ # Layer holds metadata specific to a layer of a Docker image.

1894

"directive": "A String", # The recovered Dockerfile directive used to construct this layer.

1895

"arguments": "A String", # The recovered arguments to the Dockerfile directive.

1896

},

1897

],

1898

"baseResourceUrl": "A String", # Output only. This contains the base image URL for the derived image occurrence.

1899

"fingerprint": { # A set of properties that uniquely identify a given Docker image. # The fingerprint of the derived image.

1900

"v1Name": "A String", # The layer-id of the final layer in the Docker image's v1 representation. This field can be used as a filter in list requests.

1901

"v2Blob": [ # The ordered list of v2 blobs that represent a given image.

1902

"A String",

1903

],

1904

"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. This field can be used as a filter in list requests.

1905

},

1906

"distance": 42, # Output only. The number of layers by which this image differs from the associated image basis.

1907

},

1908

"vulnerabilityDetails": { # Used by Occurrence to point to where the vulnerability exists and how to fix it. # Details of a security vulnerability note.

1909

"severity": "A String", # Output only. The note provider assigned Severity of the vulnerability.

1910

"packageIssue": [ # The set of affected locations and their fixes (if available) within the associated resource.

1911

{ # This message wraps a location affected by a vulnerability and its associated fix (if one is available).

1912

"fixedLocation": { # The location of the vulnerability # The location of the available fix for vulnerability.

1913

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1914

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1915

"revision": "A String", # The iteration of the package build from the above version.

1916

"name": "A String", # The main part of the version name.

1917

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1918

},

1919

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1920

"package": "A String", # The package being described.

1921

},

1922

"severityName": "A String",

1923

"affectedLocation": { # The location of the vulnerability # The location of the vulnerability.

1924

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version of the package being described. This field can be used as a filter in list requests.

1925

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

1926

"revision": "A String", # The iteration of the package build from the above version.

1927

"name": "A String", # The main part of the version name.

1928

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

1929

},

1930

"cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) format. Examples include distro or storage location for vulnerable jar. This field can be used as a filter in list requests.

1931

"package": "A String", # The package being described.

},

},

],

"type": "A String", # The type of package; whether native or non native(ruby gems, node.js packages etc)

1936

"cvssScore": 3.14, # Output only. The CVSS score of this vulnerability. CVSS score is on a scale of 0-10 where 0 indicates low severity and 10 indicates high severity.

1937

"effectiveSeverity": "A String", # The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability.

1938

},

1939

"resource": { # Resource is an entity that can have metadata. E.g., a Docker image. # The resource for which the `Occurrence` applies.

1940

"contentHash": { # Container message for hash values. # The hash of the resource content. E.g., the Docker digest.

1941

"type": "A String", # The type of hash that was performed.

1942

"value": "A String", # The hash value.

1943

},

1944

"uri": "A String", # The unique URI of the resource. E.g., "https://gcr.io/project/image@sha256:foo" for a Docker image.

1945

"name": "A String", # The name of the resource. E.g., the name of a Docker image - "Debian".

1946

},

1947

"attestation": { # Occurrence that represents a single "attestation". The authenticity of an Attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the AttestationAuthority to which this Attestation is attached is primarily useful for look-up (how to find this Attestation if you already know the Authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). # Describes an attestation of an artifact.

1948

"pgpSignedAttestation": { # An attestation wrapper with a PGP-compatible signature. This message only supports `ATTACHED` signatures, where the payload that is signed is included alongside the signature itself in the same file.

1949

"contentType": "A String", # Type (for example schema) of the attestation payload that was signed. The verifier must ensure that the provided type is one that the verifier supports, and that the attestation payload is a valid instantiation of that type (for example by validating a JSON schema).

1950

"pgpKeyId": "A String", # The cryptographic fingerprint of the key used to generate the signature, as output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit fingerprint, expressed as a 40 character hexadecimal string. See https://tools.ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full fingerprint is guaranteed to work. In gpg, the full fingerprint can be retrieved from the `fpr` field returned when calling --list-keys with --with-colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.

1951

"signature": "A String", # The raw content of the signature, as output by GNU Privacy Guard (GPG) or equivalent. Since this message only supports attached signatures, the payload that was signed must be attached. While the signature format supported is dependent on the verification implementation, currently only ASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.json` will create the signature content expected in this field in `signature.gpg` for the `payload.json` attestation payload.

1952

},

1953

},

1954

"createTime": "A String", # Output only. The time this `Occurrence` was created.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1955

"updateTime": "A String", # Output only. The time this `Occurrence` was last updated.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1956

"kind": "A String", # Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1957

"installation": { # This represents how a particular software package may be installed on a system. # Describes the installation of a package on the linked resource.

1958

"location": [ # All of the places within the filesystem versions of this package have been found.

1959

{ # An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1960

"path": "A String", # The path from which we gathered that this package/version is installed.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1961

"version": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # The version installed at this location.

1962

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1963

"revision": "A String", # The iteration of the package build from the above version.

1964

"name": "A String", # The main part of the version name.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1965

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1966

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1967

"cpeUri": "A String", # The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1968

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1969

],

1970

"name": "A String", # Output only. The name of the installed package.

1971

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1972

"buildDetails": { # Message encapsulating build provenance details. # Build details for a verifiable build.

1973

"provenance": { # Provenance of a build. Contains all information needed to verify the full details about the build from source to completion. # The actual provenance

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1974

"projectId": "A String", # ID of the project.

1975

"builderVersion": "A String", # Version string of the builder at the time this build was executed.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1976

"commands": [ # Commands requested by the build.

1977

{ # Command describes a step performed as part of the build pipeline.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1978

"dir": "A String", # Working directory (relative to project source root) used when running this Command.

1979

"waitFor": [ # The ID(s) of the Command(s) that this Command depends on.

1980

"A String",

1981

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1982

"args": [ # Command-line arguments used when executing this Command.

1983

"A String",

1984

],

1985

"env": [ # Environment variables set before running this Command.

1986

"A String",

1987

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1988

"id": "A String", # Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

1989

"name": "A String", # Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to `docker pull`.

1990

},

1991

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

1992

"creator": "A String", # E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.

1993

"startTime": "A String", # Time at which execution of the build was started.

1994

"triggerId": "A String", # Trigger identifier if the build was triggered automatically; empty if not.

1995

"finishTime": "A String", # Time at which execution of the build was finished.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1996

"buildOptions": { # Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details.

1997

"a_key": "A String",

1998

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1999

"logsBucket": "A String", # Google Cloud Storage bucket where logs were written.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2000

"sourceProvenance": { # Source describes the location of the source used for the build. # Details of the Source input to the build.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2001

"storageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, get the source from this location in in Google Cloud Storage.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2002

"generation": "A String", # Google Cloud Storage generation for the object.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2003

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

2004

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2005

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2006

"additionalContexts": [ # If provided, some of the source code used for the build may be found in these locations, in the case where the source repository had multiple remotes or submodules. This list will not include the context specified in the context field.

2007

{ # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2008

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2009

"url": "A String", # Git repository URL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2010

"revisionId": "A String", # Required. Git commit hash.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2011

},

2012

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2013

"revisionId": "A String", # A revision (commit) ID.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2014

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2015

"name": "A String", # The alias name.

2016

"kind": "A String", # The alias kind.

2017

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2018

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

2019

"hostUri": "A String", # The URI of a running Gerrit instance.

2020

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2021

"labels": { # Labels with user defined metadata.

2022

"a_key": "A String",

2023

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2024

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2025

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

2026

"uid": "A String", # A server-assigned, globally unique identifier.

2027

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

2028

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

2029

"projectId": "A String", # The ID of the project.

2030

},

2031

},

2032

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2033

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2034

"name": "A String", # The alias name.

2035

"kind": "A String", # The alias kind.

2036

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2037

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2038

},

2039

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2040

"context": { # A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory. # If provided, the source code used for the build came from this location.

2041

"git": { # A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub). # A SourceContext referring to any third party Git repo (e.g., GitHub).

2042

"url": "A String", # Git repository URL.

2043

"revisionId": "A String", # Required. Git commit hash.

2044

},

2045

"gerrit": { # A SourceContext referring to a Gerrit project. # A SourceContext referring to a Gerrit project.

2046

"revisionId": "A String", # A revision (commit) ID.

2047

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2048

"name": "A String", # The alias name.

2049

"kind": "A String", # The alias kind.

2050

},

2051

"gerritProject": "A String", # The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name. The "repo name" is the hostURI/project.

2052

"hostUri": "A String", # The URI of a running Gerrit instance.

2053

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2054

"labels": { # Labels with user defined metadata.

2055

"a_key": "A String",

2056

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2057

"cloudRepo": { # A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. # A SourceContext referring to a revision in a Google Cloud Source Repo.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2058

"repoId": { # A unique identifier for a Cloud Repo. # The ID of the repo.

2059

"uid": "A String", # A server-assigned, globally unique identifier.

2060

"projectRepoId": { # Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project. # A combination of a project ID and a repo name.

2061

"repoName": "A String", # The name of the repo. Leave empty for the default repo.

2062

"projectId": "A String", # The ID of the project.

2063

},

2064

},

2065

"revisionId": "A String", # A revision ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2066

"aliasContext": { # An alias to a repo revision. # An alias, which may be a branch or tag.

2067

"name": "A String", # The alias name.

2068

"kind": "A String", # The alias kind.

2069

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2070

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2071

},

2072

"repoSource": { # RepoSource describes the location of the source in a Google Cloud Source Repository. # If provided, get source from this location in a Cloud Repo.

2073

"repoName": "A String", # Name of the repo.

2074

"tagName": "A String", # Name of the tag to build.

2075

"branchName": "A String", # Name of the branch to build.

2076

"projectId": "A String", # ID of the project that owns the repo.

2077

"commitSha": "A String", # Explicit commit SHA to build.

2078

},

2079

"artifactStorageSource": { # StorageSource describes the location of the source in an archive file in Google Cloud Storage. # If provided, the input binary artifacts for the build came from this location.

2080

"generation": "A String", # Google Cloud Storage generation for the object.

2081

"bucket": "A String", # Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements)).

2082

"object": "A String", # Google Cloud Storage object containing source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2083

},

2084

"fileHashes": { # Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (.tar.gz), the FileHash will be for the single path to that file.

2085

"a_key": { # Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.

2086

"fileHash": [ # Collection of file hashes.

2087

{ # Container message for hash values.

2088

"type": "A String", # The type of hash that was performed.

2089

"value": "A String", # The hash value.

},

],

},

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2094

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2095

"builtArtifacts": [ # Output of the build.

2096

{ # Artifact describes a build product.

2097

"checksum": "A String", # Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container.

2098

"id": "A String", # Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456

2099

"names": [ # Related artifact names. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. Note that a single Artifact ID can have multiple names, for example if two tags are applied to one image.

2100

"A String",

2101

],

2102

"name": "A String", # Name of the artifact. This may be the path to a binary or jar file, or in the case of a container build, the name used to push the container image to Google Container Registry, as presented to `docker push`. This field is deprecated in favor of the plural `names` field; it continues to exist here to allow existing BuildProvenance serialized to json in google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to deserialize back into proto.

2103

},

2104

],

2105

"id": "A String", # Unique identifier of the build.

2106

"createTime": "A String", # Time at which the build was created.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2107

},

2108

"provenanceBytes": "A String", # Serialized JSON representation of the provenance, used in generating the `BuildSignature` in the corresponding Result. After verifying the signature, `provenance_bytes` can be unmarshalled and compared to the provenance to confirm that it is unchanged. A base64-encoded string representation of the provenance bytes is used for the signature in order to interoperate with openssl which expects this format for signature verification. The serialized form is captured both to avoid ambiguity in how the provenance is marshalled to json as well to prevent incompatibilities with future changes.

2109

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2110

"upgrade": { # An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). # Describes an upgrade.

2111

"distribution": { # The Upgrade Distribution represents metadata about the Upgrade for each operating system (CPE). Some distributions have additional metadata around updates, classifying them into various categories and severities. # Metadata about the upgrade for available for the specific operating system for the resource_url. This allows efficient filtering, as well as making it easier to use the occurrence.

2112

"cve": [ # The cve that would be resolved by this upgrade.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2113

"A String",

2114

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2115

"cpeUri": "A String", # Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.

2116

"classification": "A String", # The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed.

2117

"severity": "A String", # The severity as specified by the upstream operating system.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2118

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2119

"package": "A String", # Required - The package this Upgrade is for.

2120

"parsedVersion": { # Version contains structured information about the version of the package. For a discussion of this in Debian/Ubuntu: http://serverfault.com/questions/604541/debian-packages-version-convention For a discussion of this in Redhat/Fedora/Centos: http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/ # Required - The version of the package in a machine + human readable form.

2121

"epoch": 42, # Used to correct mistakes in the version numbering scheme.

2122

"revision": "A String", # The iteration of the package build from the above version.

2123

"name": "A String", # The main part of the version name.

2124

"kind": "A String", # Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored.

2125

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2126

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2127

"discovered": { # Provides information about the scan status of a discovered resource. # Describes the initial scan status for this resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2128

"analysisStatus": "A String", # The status of discovery for the resource.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2129

"operation": { # This resource represents a long-running operation that is the result of a network API call. # Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2130

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

2131

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2132

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2133

{

2134

"a_key": "", # Properties of the object. Contains field @type with type URL.

2135

},

2136

],

2137

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2138

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2139

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

2140

"a_key": "", # Properties of the object. Contains field @type with type URL.

2141

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2142

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

2143

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

2144

"a_key": "", # Properties of the object. Contains field @type with type URL.

2145

},

2146

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2147

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2148

"cpe": "A String", # The CPE of the resource being scanned.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2149

"continuousAnalysis": "A String", # Whether the resource is continuously analyzed.

2150

"analysisStatusError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # When an error is encountered this will contain a LocalizedMessage under details to show to the user. The LocalizedMessage output only and populated by the API.

2151

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2152

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2153

{

2154

"a_key": "", # Properties of the object. Contains field @type with type URL.

2155

},

2156

],

2157

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2158

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2159

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2160

"resourceUrl": "A String", # The unique URL of the image or the container for which the `Occurrence` applies. For example, https://gcr.io/project/image@sha256:foo This field can be used as a filter in list requests.

2161

"remediation": "A String", # A description of actions that can be taken to remedy the `Note`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2166

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2167

<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 a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2168

2169

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2170

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2171

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2172

The object takes the form of:

2173

2174

{ # Request message for `SetIamPolicy` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2175

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. 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. For some types of Google Cloud resources, a `binding` can also 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.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:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - 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 documentation](https://cloud.google.com/iam/docs/). # 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.

2176

"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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2177

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2178

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2179

"condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2180

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2181

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2182

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2183

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2184

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2185

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone 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@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `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`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2186

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2187

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2188

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2189

},

2190

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2191

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and 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. **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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2192

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2193

}

2194

2195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2202

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2203

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. 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. For some types of Google Cloud resources, a `binding` can also 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.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:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - 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 documentation](https://cloud.google.com/iam/docs/).

2204

"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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2205

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2206

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2207

"condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2208

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2209

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

2210

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2211

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2212

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2213

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone 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@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `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`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2214

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2215

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2216

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2217

},

2218

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

2219

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and 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. **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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2224

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2225

<pre>Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, "storage.objects.list" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2226

2227

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2228

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2229

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2230

The object takes the form of:

2231

2232

{ # Request message for `TestIamPermissions` method.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2233

"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2234

"A String",

Bu Sun Kim