Blame - docs/dyn/compute_v1.images.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

98

99

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

100

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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.</p>

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

110

<h3>Method Details</h3>

111

Bu Sun Kim

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

[diff] [blame]

112

<code class="details" id="delete">delete(project, image, requestId=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

113

<pre>Deletes the specified image.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

114

115

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

116

project: string, Project ID for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

117

image: string, Name of the image resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

118

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

119

120

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

121

122

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

123

124

Returns:

125

An object of the form:

126

Bu Sun Kim

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

[diff] [blame]

127

{ # Represents an Operation resource.

128

#

Dan O'Meara

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

[diff] [blame]

129

# Google Compute Engine has three Operation resources:

130

#

131

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

132

#

Bu Sun Kim

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

[diff] [blame]

133

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

134

#

135

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

136

# - For global operations, use the `globalOperations` resource.

137

# - For regional operations, use the `regionOperations` resource.

138

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

139

#

Dan O'Meara

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

[diff] [blame]

140

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

141

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

142

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

143

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

144

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

145

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

146

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

147

{

Bu Sun Kim

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

[diff] [blame]

148

"code": "A String", # [Output Only] The error type identifier for this error.

149

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

150

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

151

},

152

],

153

},

Bu Sun Kim

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

[diff] [blame]

154

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

155

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

156

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

157

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

158

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

159

"name": "A String", # [Output Only] Name of the operation.

160

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

161

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

162

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

163

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

164

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

165

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

166

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

167

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

168

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

169

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

170

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

171

{

172

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

173

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

174

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

175

{

176

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

177

"value": "A String", # [Output Only] A warning data value corresponding to the key.

178

},

179

],

180

"message": "A String", # [Output Only] A human-readable description of the warning code.

181

},

182

],

183

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

188

<code class="details" id="deprecate">deprecate(project, image, body=None, requestId=None)</code>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

189

<pre>Sets the deprecation status of an image.

190

191

If an empty request body is given, clears the deprecation status instead.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

192

193

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

194

project: string, Project ID for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

195

image: string, Image name. (required)

Dan O'Meara

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

[diff] [blame]

196

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

197

The object takes the form of:

198

199

{ # Deprecation status for a public resource.

Bu Sun Kim

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

[diff] [blame]

200

"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

201

"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

202

"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

203

"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

204

"state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

205

}

206

Bu Sun Kim

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

[diff] [blame]

207

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

208

209

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

210

211

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

212

213

Returns:

214

An object of the form:

215

Bu Sun Kim

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

[diff] [blame]

216

{ # Represents an Operation resource.

217

#

Dan O'Meara

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

[diff] [blame]

218

# Google Compute Engine has three Operation resources:

219

#

220

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

221

#

Bu Sun Kim

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

[diff] [blame]

222

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

223

#

224

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

225

# - For global operations, use the `globalOperations` resource.

226

# - For regional operations, use the `regionOperations` resource.

227

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

228

#

Dan O'Meara

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

[diff] [blame]

229

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

230

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

231

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

232

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

233

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

234

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

235

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

236

{

Bu Sun Kim

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

[diff] [blame]

237

"code": "A String", # [Output Only] The error type identifier for this error.

238

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

239

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

240

},

241

],

242

},

Bu Sun Kim

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

[diff] [blame]

243

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

244

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

245

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

246

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

247

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

248

"name": "A String", # [Output Only] Name of the operation.

249

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

250

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

251

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

252

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

253

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

254

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

255

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

256

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

257

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

258

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

259

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

260

{

261

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

262

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

263

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

264

{

265

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

266

"value": "A String", # [Output Only] A warning data value corresponding to the key.

267

},

268

],

269

"message": "A String", # [Output Only] A human-readable description of the warning code.

270

},

271

],

272

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, image)</code>

Bu Sun Kim

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

[diff] [blame]

278

<pre>Returns the specified image. Gets a list of available images by making a list() request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

279

280

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

281

project: string, Project ID for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

282

image: string, Name of the image resource to return. (required)

283

284

Returns:

285

An object of the form:

286

Bu Sun Kim

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

[diff] [blame]

287

{ # Represents an Image resource.

Bu Sun Kim

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

[diff] [blame]

288

#

289

# You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==)

290

"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

291

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

292

"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.

293

"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

294

"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

295

"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

296

"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

297

"state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

298

},

299

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

300

"diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).

301

"family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

302

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

303

{ # Guest OS features.

304

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

305

},

306

],

307

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

308

"imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

309

#

Bu Sun Kim

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

[diff] [blame]

310

# After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

311

#

312

# Customer-supplied encryption keys do not protect access to metadata of the disk.

313

#

314

# If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

315

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

316

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

317

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

318

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

319

},

320

"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.

321

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

322

#

323

# To see the latest fingerprint, make a get() request to retrieve an image.

324

"labels": { # Labels to apply to this image. These can be later modified by the setLabels method.

325

"a_key": "A String",

326

},

327

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this image.

328

"A String",

329

],

330

"licenses": [ # Any applicable license URI.

331

"A String",

332

],

333

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

334

"rawDisk": { # The parameters of the raw disk image.

335

"containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

336

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

337

"source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.

338

},

339

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

340

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # Set the secure boot keys of shielded instance.

341

"dbs": [ # The Key Database (db).

342

{

343

"content": "A String", # The raw content in the secure keys file.

344

"fileType": "A String", # The file type of source file.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

345

},

346

],

Bu Sun Kim

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

[diff] [blame]

347

"dbxs": [ # The forbidden key database (dbx).

348

{

349

"content": "A String", # The raw content in the secure keys file.

350

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

351

},

Bu Sun Kim

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

[diff] [blame]

352

],

353

"keks": [ # The Key Exchange Key (KEK).

354

{

355

"content": "A String", # The raw content in the secure keys file.

356

"fileType": "A String", # The file type of source file.

357

},

358

],

359

"pk": { # The Platform Key (PK).

360

"content": "A String", # The raw content in the secure keys file.

361

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

362

},

Bu Sun Kim

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

[diff] [blame]

363

},

364

"sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

365

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk

366

# - projects/project/zones/zone/disks/disk

367

# - zones/zone/disks/disk

368

"sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

369

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

370

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

371

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

372

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

373

},

374

"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

375

"sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

376

# - this property, or

377

# - the rawDisk.source property, or

378

# - the sourceDisk property in order to create an image.

379

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

380

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

381

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

382

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

383

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

384

},

385

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

386

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

387

# - this property, or

388

# - the sourceImage property, or

389

# - the rawDisk.source property, or

390

# - the sourceDisk property in order to create an image.

391

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

392

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

393

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

394

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

395

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

396

},

397

"sourceSnapshotId": "A String", # [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

398

"sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW

399

"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

400

"storageLocations": [ # Cloud Storage bucket storage location of the image (regional or multi-regional).

401

"A String",

402

],

403

}</pre>

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

</div>

<code class="details" id="getFromFamily">getFromFamily(project, family)</code>

408

<pre>Returns the latest image that is part of an image family and is not deprecated.

409

410

Args:

411

project: string, Project ID for this request. (required)

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

412

family: string, Name of the image family to search for. (required)

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

413

414

Returns:

415

An object of the form:

416

Bu Sun Kim

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

[diff] [blame]

417

{ # Represents an Image resource.

Bu Sun Kim

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

[diff] [blame]

418

#

419

# You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==)

420

"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

421

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

422

"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.

423

"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

424

"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

425

"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

426

"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

427

"state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

428

},

429

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

430

"diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).

431

"family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

432

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

433

{ # Guest OS features.

434

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

435

},

436

],

437

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

438

"imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

439

#

Bu Sun Kim

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

[diff] [blame]

440

# After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

441

#

442

# Customer-supplied encryption keys do not protect access to metadata of the disk.

443

#

444

# If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

445

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

446

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

447

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

448

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

449

},

450

"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.

451

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

452

#

453

# To see the latest fingerprint, make a get() request to retrieve an image.

454

"labels": { # Labels to apply to this image. These can be later modified by the setLabels method.

455

"a_key": "A String",

456

},

457

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this image.

458

"A String",

459

],

460

"licenses": [ # Any applicable license URI.

461

"A String",

462

],

463

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

464

"rawDisk": { # The parameters of the raw disk image.

465

"containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

466

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

467

"source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.

468

},

469

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

470

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # Set the secure boot keys of shielded instance.

471

"dbs": [ # The Key Database (db).

472

{

473

"content": "A String", # The raw content in the secure keys file.

474

"fileType": "A String", # The file type of source file.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

475

},

476

],

Bu Sun Kim

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

[diff] [blame]

477

"dbxs": [ # The forbidden key database (dbx).

478

{

479

"content": "A String", # The raw content in the secure keys file.

480

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

481

},

Bu Sun Kim

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

[diff] [blame]

482

],

483

"keks": [ # The Key Exchange Key (KEK).

484

{

485

"content": "A String", # The raw content in the secure keys file.

486

"fileType": "A String", # The file type of source file.

487

},

488

],

489

"pk": { # The Platform Key (PK).

490

"content": "A String", # The raw content in the secure keys file.

491

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

492

},

Bu Sun Kim

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

[diff] [blame]

493

},

494

"sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

495

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk

496

# - projects/project/zones/zone/disks/disk

497

# - zones/zone/disks/disk

498

"sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

499

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

500

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

501

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

502

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

503

},

504

"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

505

"sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

506

# - this property, or

507

# - the rawDisk.source property, or

508

# - the sourceDisk property in order to create an image.

509

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

510

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

511

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

512

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

513

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

514

},

515

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

516

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

517

# - this property, or

518

# - the sourceImage property, or

519

# - the rawDisk.source property, or

520

# - the sourceDisk property in order to create an image.

521

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

522

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

523

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

524

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

525

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

526

},

527

"sourceSnapshotId": "A String", # [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

528

"sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW

529

"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

530

"storageLocations": [ # Cloud Storage bucket storage location of the image (regional or multi-regional).

531

"A String",

532

],

533

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

537

<code class="details" id="getIamPolicy">getIamPolicy(project, resource)</code>

538

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

539

540

Args:

541

project: string, Project ID for this request. (required)

542

resource: string, Name or id of the resource for this request. (required)

543

544

Returns:

545

An object of the form:

546

Dan O'Meara

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

[diff] [blame]

547

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

548

#

549

#

550

#

Dan O'Meara

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

[diff] [blame]

551

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

Bu Sun Kim

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

[diff] [blame]

552

#

Bu Sun Kim

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

[diff] [blame]

553

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

Bu Sun Kim

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

[diff] [blame]

554

#

Dan O'Meara

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

[diff] [blame]

555

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

556

#

Bu Sun Kim

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

[diff] [blame]

557

# { "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 }

Bu Sun Kim

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

[diff] [blame]

558

#

Dan O'Meara

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

[diff] [blame]

559

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

560

#

Bu Sun Kim

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

[diff] [blame]

561

# 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

Bu Sun Kim

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

[diff] [blame]

562

#

Dan O'Meara

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

[diff] [blame]

563

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

564

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

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

[diff] [blame]

565

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

566

#

567

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

568

#

569

# Example Policy with multiple AuditConfigs:

570

#

Bu Sun Kim

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

[diff] [blame]

571

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

572

#

Dan O'Meara

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

[diff] [blame]

573

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

574

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

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

[diff] [blame]

575

{ # Provides the configuration for logging a type of permissions. Example:

576

#

Bu Sun Kim

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

[diff] [blame]

577

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

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

[diff] [blame]

578

#

Bu Sun Kim

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

[diff] [blame]

579

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

580

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

581

"A String",

Bu Sun Kim

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

[diff] [blame]

582

],

Bu Sun Kim

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

[diff] [blame]

583

"ignoreChildExemptions": True or False,

584

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

585

},

586

],

Bu Sun Kim

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

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

591

},

592

],

Bu Sun Kim

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

[diff] [blame]

593

"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]

594

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame]

595

"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. # The condition that is associated with this binding.

596

#

597

# If the condition evaluates to `true`, then this binding applies to the current request.

598

#

599

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

600

#

601

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

602

#

603

# Example (Comparison):

604

#

605

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

606

#

607

# Example (Equality):

608

#

609

# 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'"

614

#

615

# Example (Data Manipulation):

616

#

617

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

618

#

619

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

620

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

621

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

622

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

623

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

624

},

625

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

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

[diff] [blame]

626

#

627

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

628

#

629

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

630

#

Dan O'Meara

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

[diff] [blame]

631

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

636

#

637

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

638

#

Dan O'Meara

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

[diff] [blame]

639

# * `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.

640

#

641

# * `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.

642

#

643

# * `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.

644

#

Bu Sun Kim

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

[diff] [blame]

645

#

646

#

647

# * `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]

648

"A String",

Bu Sun Kim

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

[diff] [blame]

649

],

Bu Sun Kim

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

[diff] [blame]

650

"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]

651

},

652

],

Bu Sun Kim

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

[diff] [blame]

653

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

654

#

655

# **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.

656

"iamOwned": True or False,

657

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

658

{ # A rule to be applied in a Policy.

659

"action": "A String", # Required

660

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

661

{ # A condition to be met.

662

"iam": "A String", # Trusted attributes supplied by the IAM system.

663

"op": "A String", # An operator to apply the subject with.

664

"svc": "A String", # Trusted attributes discharged by the service.

665

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

666

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

672

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

673

"A String",

674

],

675

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

676

{ # Specifies what kind of log the caller must write

677

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

678

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

679

"permissionType": "A String", # The type of the permission that was checked.

680

},

681

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

682

},

683

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

684

#

685

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

686

#

687

# Field names correspond to IAM request parameters and field values are their respective values.

688

#

689

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

690

#

691

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

692

"customFields": [ # Custom fields.

693

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

694

"name": "A String", # Name is the field name.

695

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

696

},

697

],

698

"field": "A String", # The field value to attribute.

699

"metric": "A String", # The metric to update.

700

},

701

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

702

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

707

"A String",

708

],

709

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

715

#

716

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

717

#

718

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

719

#

720

# * 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

721

#

722

# **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.

723

#

724

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

725

#

726

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

731

<code class="details" id="insert">insert(project, body=None, forceCreate=None, requestId=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

732

<pre>Creates an image in the specified project using the data included in the request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

733

734

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

735

project: string, Project ID for this request. (required)

Dan O'Meara

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

[diff] [blame]

736

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

737

The object takes the form of:

738

Bu Sun Kim

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

[diff] [blame]

739

{ # Represents an Image resource.

Bu Sun Kim

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

[diff] [blame]

740

#

741

# You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==)

742

"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

743

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

744

"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.

745

"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

746

"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

747

"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

748

"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

749

"state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

750

},

751

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

752

"diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).

753

"family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

754

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

755

{ # Guest OS features.

756

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

757

},

758

],

759

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

760

"imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

761

#

Bu Sun Kim

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

[diff] [blame]

762

# After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

763

#

764

# Customer-supplied encryption keys do not protect access to metadata of the disk.

765

#

766

# If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

767

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

768

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

769

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

770

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

771

},

772

"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.

773

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

774

#

775

# To see the latest fingerprint, make a get() request to retrieve an image.

776

"labels": { # Labels to apply to this image. These can be later modified by the setLabels method.

777

"a_key": "A String",

778

},

779

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this image.

780

"A String",

781

],

782

"licenses": [ # Any applicable license URI.

783

"A String",

784

],

785

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

786

"rawDisk": { # The parameters of the raw disk image.

787

"containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

788

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

789

"source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.

790

},

791

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

792

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # Set the secure boot keys of shielded instance.

793

"dbs": [ # The Key Database (db).

794

{

795

"content": "A String", # The raw content in the secure keys file.

796

"fileType": "A String", # The file type of source file.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

797

},

798

],

Bu Sun Kim

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

[diff] [blame]

799

"dbxs": [ # The forbidden key database (dbx).

800

{

801

"content": "A String", # The raw content in the secure keys file.

802

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

803

},

Bu Sun Kim

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

[diff] [blame]

804

],

805

"keks": [ # The Key Exchange Key (KEK).

806

{

807

"content": "A String", # The raw content in the secure keys file.

808

"fileType": "A String", # The file type of source file.

809

},

810

],

811

"pk": { # The Platform Key (PK).

812

"content": "A String", # The raw content in the secure keys file.

813

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

814

},

Bu Sun Kim

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

[diff] [blame]

815

},

816

"sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

817

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk

818

# - projects/project/zones/zone/disks/disk

819

# - zones/zone/disks/disk

820

"sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

821

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

822

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

823

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

824

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

825

},

826

"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

827

"sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

828

# - this property, or

829

# - the rawDisk.source property, or

830

# - the sourceDisk property in order to create an image.

831

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

832

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

833

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

834

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

835

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

836

},

837

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

838

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

839

# - this property, or

840

# - the sourceImage property, or

841

# - the rawDisk.source property, or

842

# - the sourceDisk property in order to create an image.

843

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

844

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

845

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

846

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

847

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

848

},

849

"sourceSnapshotId": "A String", # [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

850

"sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW

851

"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

852

"storageLocations": [ # Cloud Storage bucket storage location of the image (regional or multi-regional).

853

"A String",

854

],

855

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

856

Bu Sun Kim

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

[diff] [blame]

857

forceCreate: boolean, Force image creation if true.

Bu Sun Kim

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

[diff] [blame]

858

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

859

860

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

861

862

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

863

864

Returns:

865

An object of the form:

866

Bu Sun Kim

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

[diff] [blame]

867

{ # Represents an Operation resource.

868

#

Dan O'Meara

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

[diff] [blame]

869

# Google Compute Engine has three Operation resources:

870

#

871

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

872

#

Bu Sun Kim

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

[diff] [blame]

873

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

874

#

875

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

876

# - For global operations, use the `globalOperations` resource.

877

# - For regional operations, use the `regionOperations` resource.

878

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

879

#

Dan O'Meara

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

[diff] [blame]

880

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

881

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

882

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

883

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

884

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

885

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

886

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

887

{

Bu Sun Kim

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

[diff] [blame]

888

"code": "A String", # [Output Only] The error type identifier for this error.

889

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

890

"message": "A String", # [Output Only] An optional, human-readable error message.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

891

},

892

],

893

},

Bu Sun Kim

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

[diff] [blame]

894

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

895

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

896

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

897

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

898

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

899

"name": "A String", # [Output Only] Name of the operation.

900

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

901

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

902

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

903

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

904

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

905

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

906

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

907

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

908

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

909

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

910

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

911

{

912

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

913

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

914

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

915

{

916

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

917

"value": "A String", # [Output Only] A warning data value corresponding to the key.

918

},

919

],

920

"message": "A String", # [Output Only] A human-readable description of the warning code.

921

},

922

],

923

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

928

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Bu Sun Kim

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

[diff] [blame]

929

<pre>Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

930

931

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

932

project: string, Project ID for this request. (required)

Dan O'Meara

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

[diff] [blame]

933

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

934

Dan O'Meara

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

[diff] [blame]

935

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

936

Dan O'Meara

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

[diff] [blame]

937

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

938

Bu Sun Kim

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

[diff] [blame]

939

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

940

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

941

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

942

943

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

944

945

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

946

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

947

948

Returns:

949

An object of the form:

950

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

951

{ # Contains a list of images.

Bu Sun Kim

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

[diff] [blame]

952

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

953

"items": [ # A list of Image resources.

Bu Sun Kim

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

[diff] [blame]

954

{ # Represents an Image resource.

Bu Sun Kim

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

[diff] [blame]

955

#

956

# You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==)

957

"archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

958

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

959

"deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image.

960

"deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.

961

"deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.

962

"obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.

963

"replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.

964

"state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

965

},

Bu Sun Kim

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

[diff] [blame]

966

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

967

"diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB).

968

"family": "A String", # The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

969

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

970

{ # Guest OS features.

971

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

972

},

973

],

974

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

975

"imageEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the image using a customer-supplied encryption key.

976

#

977

# After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).

978

#

979

# Customer-supplied encryption keys do not protect access to metadata of the disk.

980

#

981

# If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later.

982

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

983

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

984

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

985

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

986

},

987

"kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images.

988

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

989

#

990

# To see the latest fingerprint, make a get() request to retrieve an image.

991

"labels": { # Labels to apply to this image. These can be later modified by the setLabels method.

992

"a_key": "A String",

993

},

994

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this image.

995

"A String",

996

],

997

"licenses": [ # Any applicable license URI.

998

"A String",

999

],

1000

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1001

"rawDisk": { # The parameters of the raw disk image.

1002

"containerType": "A String", # The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

1003

"sha1Checksum": "A String", # [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.

1004

"source": "A String", # The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.

1005

},

1006

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1007

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # Set the secure boot keys of shielded instance.

1008

"dbs": [ # The Key Database (db).

1009

{

1010

"content": "A String", # The raw content in the secure keys file.

1011

"fileType": "A String", # The file type of source file.

1012

},

1013

],

1014

"dbxs": [ # The forbidden key database (dbx).

1015

{

1016

"content": "A String", # The raw content in the secure keys file.

1017

"fileType": "A String", # The file type of source file.

1018

},

1019

],

1020

"keks": [ # The Key Exchange Key (KEK).

1021

{

1022

"content": "A String", # The raw content in the secure keys file.

1023

"fileType": "A String", # The file type of source file.

1024

},

1025

],

1026

"pk": { # The Platform Key (PK).

1027

"content": "A String", # The raw content in the secure keys file.

1028

"fileType": "A String", # The file type of source file.

1029

},

1030

},

1031

"sourceDisk": "A String", # URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

1032

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk

1033

# - projects/project/zones/zone/disks/disk

1034

# - zones/zone/disks/disk

1035

"sourceDiskEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

1036

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1037

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1038

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1039

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1040

},

1041

"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.

1042

"sourceImage": "A String", # URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

1043

# - this property, or

1044

# - the rawDisk.source property, or

1045

# - the sourceDisk property in order to create an image.

1046

"sourceImageEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1047

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1048

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1049

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1050

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1051

},

1052

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.

1053

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:

1054

# - this property, or

1055

# - the sourceImage property, or

1056

# - the rawDisk.source property, or

1057

# - the sourceDisk property in order to create an image.

1058

"sourceSnapshotEncryptionKey": { # Represents a customer-supplied encryption key # The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

1059

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1060

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1061

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1062

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1063

},

1064

"sourceSnapshotId": "A String", # [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.

1065

"sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW

1066

"status": "A String", # [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

1067

"storageLocations": [ # Cloud Storage bucket storage location of the image (regional or multi-regional).

1068

"A String",

1069

],

1070

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1071

],

Bu Sun Kim

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

[diff] [blame]

1072

"kind": "compute#imageList", # Type of resource.

1073

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

1074

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1075

"warning": { # [Output Only] Informational warning message.

1076

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

1077

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1078

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

1079

{

Bu Sun Kim

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

[diff] [blame]

1080

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1081

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

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

[diff] [blame]

1082

},

1083

],

Bu Sun Kim

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

[diff] [blame]

1084

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

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

[diff] [blame]

1085

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1091

<pre>Retrieves the next page of results.

1092

1093

Args:

1094

previous_request: The request for the previous page. (required)

1095

previous_response: The response from the request for the previous page. (required)

1096

1097

Returns:

Bu Sun Kim

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

[diff] [blame]

1098

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1099

page. Returns None if there are no more items in the collection.

</pre>

</div>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1103

Dan O'Meara

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

[diff] [blame]

1104

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

Bu Sun Kim

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

[diff] [blame]

1105

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1106

1107

Args:

1108

project: string, Project ID for this request. (required)

Bu Sun Kim

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

[diff] [blame]

1109

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

1110

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1111

The object takes the form of:

1112

1113

{

Bu Sun Kim

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

[diff] [blame]

1114

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1115

{ # Associates `members` with a `role`.

1116

"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. # The condition that is associated with this binding.

1117

#

1118

# If the condition evaluates to `true`, then this binding applies to the current request.

1119

#

1120

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

1121

#

1122

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1123

#

1124

# Example (Comparison):

1125

#

1126

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1127

#

1128

# Example (Equality):

1129

#

1130

# 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'"

1135

#

1136

# Example (Data Manipulation):

1137

#

1138

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1139

#

1140

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

1141

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

1142

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1143

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

1144

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

1145

},

1146

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1147

#

1148

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1149

#

1150

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1151

#

1152

# * `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`.

1157

#

1158

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1159

#

1160

# * `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.

1161

#

1162

# * `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.

1163

#

1164

# * `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`.

1169

"A String",

1170

],

1171

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1172

},

1173

],

1174

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1175

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # 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 in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

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

[diff] [blame]

1176

#

1177

#

1178

#

Dan O'Meara

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

[diff] [blame]

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

#

Bu Sun Kim

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

[diff] [blame]

1181

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

Bu Sun Kim

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

[diff] [blame]

1182

#

Dan O'Meara

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

[diff] [blame]

1183

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1184

#

Bu Sun Kim

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

[diff] [blame]

1185

# { "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 }

Bu Sun Kim

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

[diff] [blame]

1186

#

Dan O'Meara

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

[diff] [blame]

1187

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1188

#

Bu Sun Kim

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

[diff] [blame]

1189

# 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

Bu Sun Kim

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

[diff] [blame]

1190

#

Dan O'Meara

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

[diff] [blame]

1191

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

1192

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

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

[diff] [blame]

1193

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

1194

#

1195

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

1196

#

1197

# Example Policy with multiple AuditConfigs:

1198

#

Bu Sun Kim

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

[diff] [blame]

1199

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

1200

#

Dan O'Meara

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

[diff] [blame]

1201

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

1202

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

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

[diff] [blame]

1203

{ # Provides the configuration for logging a type of permissions. Example:

1204

#

Bu Sun Kim

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

[diff] [blame]

1205

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

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

[diff] [blame]

1206

#

Bu Sun Kim

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

[diff] [blame]

1207

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1208

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1209

"A String",

Bu Sun Kim

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

[diff] [blame]

1210

],

Bu Sun Kim

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

[diff] [blame]

1211

"ignoreChildExemptions": True or False,

1212

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

1213

},

1214

],

Bu Sun Kim

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

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

1219

},

1220

],

Bu Sun Kim

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

[diff] [blame]

1221

"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]

1222

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame]

1223

"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. # The condition that is associated with this binding.

1224

#

1225

# If the condition evaluates to `true`, then this binding applies to the current request.

1226

#

1227

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

1228

#

1229

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1230

#

1231

# Example (Comparison):

1232

#

1233

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1234

#

1235

# Example (Equality):

1236

#

1237

# 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'"

1242

#

1243

# Example (Data Manipulation):

1244

#

1245

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1246

#

1247

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

1248

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

1249

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1250

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

1251

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

1252

},

1253

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

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

[diff] [blame]

1254

#

1255

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1256

#

1257

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1258

#

Dan O'Meara

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

[diff] [blame]

1259

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1264

#

1265

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1266

#

Dan O'Meara

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

[diff] [blame]

1267

# * `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.

1268

#

1269

# * `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.

1270

#

1271

# * `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.

1272

#

Bu Sun Kim

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

[diff] [blame]

1273

#

1274

#

1275

# * `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]

1276

"A String",

Bu Sun Kim

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

[diff] [blame]

1277

],

Bu Sun Kim

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

[diff] [blame]

1278

"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]

1279

},

1280

],

Bu Sun Kim

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

[diff] [blame]

1281

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

1282

#

1283

# **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.

1284

"iamOwned": True or False,

1285

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

1286

{ # A rule to be applied in a Policy.

1287

"action": "A String", # Required

1288

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1289

{ # A condition to be met.

1290

"iam": "A String", # Trusted attributes supplied by the IAM system.

1291

"op": "A String", # An operator to apply the subject with.

1292

"svc": "A String", # Trusted attributes discharged by the service.

1293

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1294

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1300

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

1301

"A String",

1302

],

1303

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1304

{ # Specifies what kind of log the caller must write

1305

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1306

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1307

"permissionType": "A String", # The type of the permission that was checked.

1308

},

1309

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1310

},

1311

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1312

#

1313

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

1314

#

1315

# Field names correspond to IAM request parameters and field values are their respective values.

1316

#

1317

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

1318

#

1319

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1320

"customFields": [ # Custom fields.

1321

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1322

"name": "A String", # Name is the field name.

1323

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1324

},

1325

],

1326

"field": "A String", # The field value to attribute.

1327

"metric": "A String", # The metric to update.

1328

},

1329

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1330

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1335

"A String",

1336

],

1337

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

1338

"A String",

1339

],

Bu Sun Kim

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

[diff] [blame]

1340

},

Bu Sun Kim

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

[diff] [blame]

1341

],

1342

"version": 42, # Specifies the format of the policy.

1343

#

1344

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1345

#

1346

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1347

#

1348

# * 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

1349

#

1350

# **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.

1351

#

1352

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1353

#

1354

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1355

},

Bu Sun Kim

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

[diff] [blame]

}

Returns:

An object of the form:

1361

Dan O'Meara

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

[diff] [blame]

1362

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

1363

#

1364

#

1365

#

Dan O'Meara

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

[diff] [blame]

1366

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

Bu Sun Kim

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

[diff] [blame]

1367

#

Bu Sun Kim

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

[diff] [blame]

1368

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

Bu Sun Kim

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

[diff] [blame]

1369

#

Dan O'Meara

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

[diff] [blame]

1370

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1371

#

Bu Sun Kim

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

[diff] [blame]

1372

# { "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 }

Bu Sun Kim

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

[diff] [blame]

1373

#

Dan O'Meara

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

[diff] [blame]

1374

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1375

#

Bu Sun Kim

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

[diff] [blame]

1376

# 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

Bu Sun Kim

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

[diff] [blame]

1377

#

Dan O'Meara

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

[diff] [blame]

1378

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

1379

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

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

[diff] [blame]

1380

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

1381

#

1382

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

1383

#

1384

# Example Policy with multiple AuditConfigs:

1385

#

Bu Sun Kim

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

[diff] [blame]

1386

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

1387

#

Dan O'Meara

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

[diff] [blame]

1388

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

1389

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

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

[diff] [blame]

1390

{ # Provides the configuration for logging a type of permissions. Example:

1391

#

Bu Sun Kim

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

[diff] [blame]

1392

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

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

[diff] [blame]

1393

#

Bu Sun Kim

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

[diff] [blame]

1394

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1395

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1396

"A String",

Bu Sun Kim

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

[diff] [blame]

1397

],

Bu Sun Kim

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

[diff] [blame]

1398

"ignoreChildExemptions": True or False,

1399

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

1400

},

1401

],

Bu Sun Kim

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

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

1406

},

1407

],

Bu Sun Kim

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

[diff] [blame]

1408

"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]

1409

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame]

1410

"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. # The condition that is associated with this binding.

1411

#

1412

# If the condition evaluates to `true`, then this binding applies to the current request.

1413

#

1414

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

1415

#

1416

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1417

#

1418

# Example (Comparison):

1419

#

1420

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1421

#

1422

# Example (Equality):

1423

#

1424

# 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'"

1429

#

1430

# Example (Data Manipulation):

1431

#

1432

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1433

#

1434

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

1435

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

1436

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1437

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

1438

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

1439

},

1440

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

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

[diff] [blame]

1441

#

1442

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1443

#

1444

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1445

#

Dan O'Meara

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

[diff] [blame]

1446

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1451

#

1452

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1453

#

Dan O'Meara

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

[diff] [blame]

1454

# * `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.

1455

#

1456

# * `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.

1457

#

1458

# * `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.

1459

#

Bu Sun Kim

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

[diff] [blame]

1460

#

1461

#

1462

# * `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]

1463

"A String",

Bu Sun Kim

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

[diff] [blame]

1464

],

Bu Sun Kim

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

[diff] [blame]

1465

"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]

1466

},

1467

],

Bu Sun Kim

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

[diff] [blame]

1468

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

1469

#

1470

# **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.

1471

"iamOwned": True or False,

1472

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

1473

{ # A rule to be applied in a Policy.

1474

"action": "A String", # Required

1475

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1476

{ # A condition to be met.

1477

"iam": "A String", # Trusted attributes supplied by the IAM system.

1478

"op": "A String", # An operator to apply the subject with.

1479

"svc": "A String", # Trusted attributes discharged by the service.

1480

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1481

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1487

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

1488

"A String",

1489

],

1490

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1491

{ # Specifies what kind of log the caller must write

1492

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1493

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1494

"permissionType": "A String", # The type of the permission that was checked.

1495

},

1496

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1497

},

1498

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1499

#

1500

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

1501

#

1502

# Field names correspond to IAM request parameters and field values are their respective values.

1503

#

1504

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

1505

#

1506

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1507

"customFields": [ # Custom fields.

1508

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1509

"name": "A String", # Name is the field name.

1510

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1511

},

1512

],

1513

"field": "A String", # The field value to attribute.

1514

"metric": "A String", # The metric to update.

1515

},

1516

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1517

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1522

"A String",

1523

],

1524

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

1530

#

1531

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1532

#

1533

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1534

#

1535

# * 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

1536

#

1537

# **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.

1538

#

1539

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1540

#

1541

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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]

1546

<code class="details" id="setLabels">setLabels(project, resource, body=None)</code>

Bu Sun Kim

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

[diff] [blame]

1547

<pre>Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

1548

1549

Args:

1550

project: string, Project ID for this request. (required)

1551

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

1552

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1553

The object takes the form of:

1554

1555

{

Bu Sun Kim

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

[diff] [blame]

1556

"labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.

1557

"labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").

1558

"a_key": "A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

},

}

Returns:

An object of the form:

1565

Bu Sun Kim

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

[diff] [blame]

1566

{ # Represents an Operation resource.

1567

#

Dan O'Meara

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

[diff] [blame]

1568

# Google Compute Engine has three Operation resources:

1569

#

1570

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1571

#

Bu Sun Kim

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

[diff] [blame]

1572

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1573

#

1574

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1575

# - For global operations, use the `globalOperations` resource.

1576

# - For regional operations, use the `regionOperations` resource.

1577

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

1578

#

Dan O'Meara

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

[diff] [blame]

1579

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

1580

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1581

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1582

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1583

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1584

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1585

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1586

{

Bu Sun Kim

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

[diff] [blame]

1587

"code": "A String", # [Output Only] The error type identifier for this error.

1588

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1589

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1590

},

1591

],

1592

},

Bu Sun Kim