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

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

[diff] [blame]

100

<p class="firstline">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.</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

101

102

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

103

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

104

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

105

<code><a href="#patch">patch(project, image, body=None, requestId=None, x__xgafv=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

106

<p class="firstline">Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.</p>

107

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

108

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

109

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

110

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

113

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

114

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

115

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

116

<h3>Method Details</h3>

117

Dmitry Frenkel

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

[diff] [blame]

118

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

119

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

123

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

124

<pre>Deletes the specified image.

125

126

Args:

127

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

128

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

129

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

130

x__xgafv: string, V1 error format.

131

Allowed values

132

1 - v1 error format

133

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

134

135

Returns:

136

An object of the form:

137

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

138

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

139

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

140

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

141

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

142

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

143

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

144

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

Bu Sun Kim

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

[diff] [blame]

145

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

146

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

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

},

150

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

151

},

152

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

153

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

154

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

155

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

156

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

yoshi-code-bot

2021-11-02 00:26:17 -0700

[diff] [blame^]

157

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

158

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

159

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

160

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

161

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

162

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

163

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

164

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

165

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

166

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

{

175

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

176

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

177

{

178

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

179

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

180

},

181

],

182

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

183

},

184

],

185

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

186

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

190

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

191

<pre>Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

192

193

Args:

194

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

195

image: string, Image name. (required)

Dan O'Meara

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

[diff] [blame]

196

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

205

"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

206

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

207

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

208

"a_key": "A String",

209

},

210

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

211

}

212

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

213

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

214

x__xgafv: string, V1 error format.

215

Allowed values

216

1 - v1 error format

217

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

218

219

Returns:

220

An object of the form:

221

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

222

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

223

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

224

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

225

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

226

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

227

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

228

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

Bu Sun Kim

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

[diff] [blame]

229

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

230

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

231

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

232

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

Bu Sun Kim

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

[diff] [blame]

233

},

234

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

235

},

236

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

237

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

238

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

239

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

240

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

yoshi-code-bot

2021-11-02 00:26:17 -0700

[diff] [blame^]

241

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

242

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

243

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

244

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

245

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

246

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

247

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

248

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

249

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

250

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

{

259

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

260

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

261

{

262

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

263

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

264

},

265

],

266

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

267

},

268

],

269

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

270

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

274

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

Bu Sun Kim

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

[diff] [blame]

275

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

276

277

Args:

278

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

279

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

280

x__xgafv: string, V1 error format.

281

Allowed values

282

1 - v1 error format

283

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

284

285

Returns:

286

An object of the form:

287

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

288

{ # Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

297

"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

298

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

299

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

300

"a_key": "A String",

301

},

302

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

303

},

304

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

305

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

306

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

307

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

308

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

309

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

310

},

311

],

312

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

313

"imageEncryptionKey": { # Encrypts the image using a customer-supplied encryption key. 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). Customer-supplied encryption keys do not protect access to metadata of the disk. 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.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

314

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

315

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

316

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

317

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

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. To see the latest fingerprint, make a get() request to retrieve an image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

322

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

323

"a_key": "A String",

324

},

325

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

326

"A String",

327

],

328

"licenses": [ # Any applicable license URI.

329

"A String",

330

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

331

"locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

332

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

333

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

334

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

335

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

336

"source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

337

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

338

"rolloutOverride": { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

339

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

340

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"a_key": "A String",

},

},

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

345

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

346

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.

347

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

348

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

349

{

Bu Sun Kim

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

[diff] [blame]

350

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

351

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

Bu Sun Kim

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

[diff] [blame]

352

},

Bu Sun Kim

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

[diff] [blame]

353

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

354

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

355

{

356

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

357

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

358

},

359

],

360

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

361

{

362

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

363

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

364

},

365

],

366

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

367

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

368

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

369

},

370

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

371

"sourceDisk": "A String", # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

372

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

373

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

374

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

375

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

376

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

377

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

378

},

379

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

380

"sourceImage": "A String", # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

381

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

382

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

383

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

384

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

385

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

386

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

387

},

388

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

389

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

390

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

391

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

392

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

393

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

394

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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

],

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

403

"userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

404

"A String",

405

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

406

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

410

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

411

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

412

413

Args:

414

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

415

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

416

x__xgafv: string, V1 error format.

417

Allowed values

418

1 - v1 error format

419

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

420

421

Returns:

422

An object of the form:

423

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

424

{ # Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

433

"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

434

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

435

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

436

"a_key": "A String",

437

},

438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

439

},

440

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

441

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

442

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

443

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

444

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

445

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

446

},

447

],

448

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

449

"imageEncryptionKey": { # Encrypts the image using a customer-supplied encryption key. 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). Customer-supplied encryption keys do not protect access to metadata of the disk. 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.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

450

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

451

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

452

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

453

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

454

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

455

},

456

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

457

"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. To see the latest fingerprint, make a get() request to retrieve an image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

458

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

459

"a_key": "A String",

460

},

461

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

462

"A String",

463

],

464

"licenses": [ # Any applicable license URI.

465

"A String",

466

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

467

"locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

468

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

469

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

470

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

471

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

472

"source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

473

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

474

"rolloutOverride": { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

475

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

476

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"a_key": "A String",

},

},

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

481

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

482

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.

483

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

484

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

485

{

Bu Sun Kim

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

[diff] [blame]

486

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

487

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

Bu Sun Kim

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

[diff] [blame]

488

},

Bu Sun Kim

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

[diff] [blame]

489

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

490

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

491

{

492

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

493

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

494

},

495

],

496

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

497

{

498

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

499

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

500

},

501

],

502

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

503

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

504

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

505

},

506

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

507

"sourceDisk": "A String", # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

508

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

509

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

510

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

511

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

512

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

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

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

516

"sourceImage": "A String", # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

517

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

518

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

519

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

520

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

521

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

522

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

523

},

524

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

525

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

526

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

527

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

528

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

529

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

530

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

531

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

532

},

533

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

534

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

535

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

536

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

537

"A String",

538

],

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

539

"userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

540

"A String",

541

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

542

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

546

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

547

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

548

549

Args:

550

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

Bu Sun Kim

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

[diff] [blame]

551

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

Dan O'Meara

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

[diff] [blame]

552

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

553

x__xgafv: string, V1 error format.

554

Allowed values

555

1 - v1 error format

556

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

557

558

Returns:

559

An object of the form:

560

yoshi-code-bot

8bb904c

2021-08-31 00:28:27 -0700

[diff] [blame]

561

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

562

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

563

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user: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" ] } ] } ] } 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

564

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

565

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

566

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

567

"A String",

568

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

569

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

570

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

Bu Sun Kim

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

[diff] [blame]

571

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

572

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

573

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

574

"A String",

575

],

576

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

577

},

578

],

579

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

580

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

581

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

582

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

583

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

584

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

585

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

586

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

587

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

588

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

589

"A String",

590

],

591

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

592

},

593

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

594

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

595

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

596

"rules": [ # This is deprecated and has no effect. Do not use.

597

{ # This is deprecated and has no effect. Do not use.

598

"action": "A String", # This is deprecated and has no effect. Do not use.

599

"conditions": [ # This is deprecated and has no effect. Do not use.

600

{ # This is deprecated and has no effect. Do not use.

601

"iam": "A String", # This is deprecated and has no effect. Do not use.

602

"op": "A String", # This is deprecated and has no effect. Do not use.

603

"svc": "A String", # This is deprecated and has no effect. Do not use.

604

"sys": "A String", # This is deprecated and has no effect. Do not use.

605

"values": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

610

"description": "A String", # This is deprecated and has no effect. Do not use.

611

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

612

"A String",

613

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

614

"logConfigs": [ # This is deprecated and has no effect. Do not use.

615

{ # This is deprecated and has no effect. Do not use.

616

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

617

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

618

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

619

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

620

"logName": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

621

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

622

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

623

"customFields": [ # This is deprecated and has no effect. Do not use.

624

{ # This is deprecated and has no effect. Do not use.

625

"name": "A String", # This is deprecated and has no effect. Do not use.

626

"value": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

627

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

628

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

629

"field": "A String", # This is deprecated and has no effect. Do not use.

630

"metric": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

631

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

632

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

633

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

634

},

635

},

636

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

637

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

638

"A String",

639

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

640

"permissions": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

645

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

646

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

650

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

651

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

652

653

Args:

654

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

Dan O'Meara

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

[diff] [blame]

655

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

656

The object takes the form of:

657

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

658

{ # Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Bu Sun Kim

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

[diff] [blame]

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

667

"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

668

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

669

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

670

"a_key": "A String",

671

},

672

},

Bu Sun Kim

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

[diff] [blame]

673

},

674

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

675

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

676

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

677

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

Bu Sun Kim

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

[diff] [blame]

678

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

679

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

Bu Sun Kim

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

[diff] [blame]

680

},

681

],

682

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

683

"imageEncryptionKey": { # Encrypts the image using a customer-supplied encryption key. 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). Customer-supplied encryption keys do not protect access to metadata of the disk. 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.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

684

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

685

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

686

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

687

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

688

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

689

},

690

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

691

"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. To see the latest fingerprint, make a get() request to retrieve an image.

Bu Sun Kim

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

[diff] [blame]

692

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

693

"a_key": "A String",

694

},

695

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

696

"A String",

697

],

698

"licenses": [ # Any applicable license URI.

699

"A String",

700

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

701

"locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Bu Sun Kim

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

[diff] [blame]

702

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

703

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

704

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

705

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

706

"source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Bu Sun Kim

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

[diff] [blame]

707

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

708

"rolloutOverride": { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

709

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

710

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"a_key": "A String",

},

},

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Bu Sun Kim

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

[diff] [blame]

715

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

716

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.

717

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

718

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

719

{

720

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

721

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

722

},

723

],

Bu Sun Kim

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

[diff] [blame]

724

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

725

{

726

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

727

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

Bu Sun Kim

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

[diff] [blame]

728

},

Bu Sun Kim

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

[diff] [blame]

729

],

730

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

731

{

732

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

733

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

734

},

735

],

736

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

737

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

738

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

Bu Sun Kim

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

[diff] [blame]

739

},

Bu Sun Kim

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

[diff] [blame]

740

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

741

"sourceDisk": "A String", # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Dmitry Frenkel

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

[diff] [blame]

742

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

743

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

744

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

745

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

746

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

747

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

748

},

749

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

750

"sourceImage": "A String", # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Dmitry Frenkel

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

[diff] [blame]

751

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

752

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

753

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

754

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

755

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

756

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

757

},

758

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

759

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Dmitry Frenkel

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

[diff] [blame]

760

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

761

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

762

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

763

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

764

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

765

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

766

},

767

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

768

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

769

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

770

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

771

"A String",

772

],

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

773

"userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

774

"A String",

775

],

Bu Sun Kim

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

[diff] [blame]

776

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

777

Bu Sun Kim

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

[diff] [blame]

778

forceCreate: boolean, Force image creation if true.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

779

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

780

x__xgafv: string, V1 error format.

781

Allowed values

782

1 - v1 error format

783

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

784

785

Returns:

786

An object of the form:

787

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

788

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

789

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

790

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

791

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

792

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

793

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

794

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

Bu Sun Kim

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

[diff] [blame]

795

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

796

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

797

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

798

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

Bu Sun Kim

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

[diff] [blame]

799

},

800

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

801

},

802

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

803

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

804

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

805

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

806

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

yoshi-code-bot

2021-11-02 00:26:17 -0700

[diff] [blame^]

807

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

808

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

809

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

810

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

811

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

812

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

813

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

814

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

815

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

816

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

817

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

818

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

819

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

820

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

821

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

822

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

823

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

824

{

825

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

826

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

827

{

828

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

829

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

830

},

831

],

832

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

833

},

834

],

835

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

836

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

840

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

Bu Sun Kim

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

[diff] [blame]

841

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

842

843

Args:

844

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

845

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```

Bu Sun Kim

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

[diff] [blame]

846

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`)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

847

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

848

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

849

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

850

x__xgafv: string, V1 error format.

851

Allowed values

852

1 - v1 error format

853

2 - v2 error format

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

854

zone: string, The zone query parameter.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

855

856

Returns:

857

An object of the form:

858

859

{ # Contains a list of images.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

860

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

861

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

862

{ # Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

863

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

864

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

865

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

866

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

867

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

868

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

869

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

870

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

871

"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

872

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

873

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

874

"a_key": "A String",

875

},

876

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

877

},

878

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

879

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

880

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

881

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

882

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

883

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

884

},

885

],

886

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

887

"imageEncryptionKey": { # Encrypts the image using a customer-supplied encryption key. 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). Customer-supplied encryption keys do not protect access to metadata of the disk. 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.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

888

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

889

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

890

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

891

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

892

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

893

},

894

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

895

"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. To see the latest fingerprint, make a get() request to retrieve an image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

896

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

897

"a_key": "A String",

898

},

899

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

900

"A String",

901

],

902

"licenses": [ # Any applicable license URI.

903

"A String",

904

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

905

"locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

906

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

907

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

908

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

909

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

910

"source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

911

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

912

"rolloutOverride": { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

913

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

914

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"a_key": "A String",

},

},

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

919

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

920

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.

921

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

922

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

923

{

Bu Sun Kim

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

[diff] [blame]

924

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

925

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

926

},

Bu Sun Kim

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

[diff] [blame]

927

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

928

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

929

{

930

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

931

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

932

},

933

],

934

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

935

{

936

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

937

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

938

},

939

],

940

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

941

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

942

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

943

},

944

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

945

"sourceDisk": "A String", # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

946

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

947

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

948

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

949

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

950

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

951

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

952

},

953

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

954

"sourceImage": "A String", # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

955

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

956

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

957

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

958

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

959

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

960

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

961

},

962

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

963

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

964

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

965

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

966

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

967

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

968

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

969

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

970

},

971

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

972

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

973

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

974

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

975

"A String",

976

],

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

977

"userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

978

"A String",

979

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

980

},

981

],

982

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

983

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

984

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

985

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

986

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

987

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

988

{

989

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

990

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

Bu Sun Kim

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

[diff] [blame]

991

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

992

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

993

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

994

},

995

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

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

1000

<pre>Retrieves the next page of results.

1001

1002

Args:

1003

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

1004

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

1005

1006

Returns:

Bu Sun Kim

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

[diff] [blame]

1007

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1008

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

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1013

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

Dan O'Meara

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

[diff] [blame]

1014

<pre>Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

1015

1016

Args:

1017

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

1018

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

1019

body: object, The request body.

1020

The object takes the form of:

1021

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1022

{ # Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Bu Sun Kim

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

[diff] [blame]

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1031

"stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1032

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1033

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1034

"a_key": "A String",

1035

},

1036

},

Bu Sun Kim

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

[diff] [blame]

1037

},

1038

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

1039

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

1040

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1041

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

Bu Sun Kim

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

[diff] [blame]

1042

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1043

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

Bu Sun Kim

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

[diff] [blame]

1044

},

1045

],

1046

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1047

"imageEncryptionKey": { # Encrypts the image using a customer-supplied encryption key. 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). Customer-supplied encryption keys do not protect access to metadata of the disk. 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.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1048

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1049

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1050

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1051

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1052

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

1053

},

1054

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1055

"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. To see the latest fingerprint, make a get() request to retrieve an image.

Bu Sun Kim

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

[diff] [blame]

1056

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

1057

"a_key": "A String",

1058

},

1059

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

1060

"A String",

1061

],

1062

"licenses": [ # Any applicable license URI.

1063

"A String",

1064

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1065

"locked": True or False, # A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

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

1068

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

1069

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1070

"source": "A String", # The full Google Cloud Storage URL where the raw disk image archive is stored. The following are valid formats for the URL: - https://storage.googleapis.com/bucket_name/image_archive_name - https://storage.googleapis.com/bucket_name/folder_name/ image_archive_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Bu Sun Kim

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

[diff] [blame]

1071

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1072

"rolloutOverride": { # A rollout policy configuration. # A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1073

"defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1074

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"a_key": "A String",

},

},

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

Bu Sun Kim

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

[diff] [blame]

1079

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

1080

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.

1081

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

1082

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

1083

{

1084

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

1085

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

Dan O'Meara

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

[diff] [blame]

1086

},

1087

],

Bu Sun Kim

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

[diff] [blame]

1088

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

1089

{

1090

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

1091

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

Dan O'Meara

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

[diff] [blame]

1092

},

Bu Sun Kim

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

[diff] [blame]

1093

],

1094

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

1095

{

1096

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

1097

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

1098

},

1099

],

1100

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

1101

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

1102

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

Dan O'Meara

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

[diff] [blame]

1103

},

Bu Sun Kim

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

[diff] [blame]

1104

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1105

"sourceDisk": "A String", # URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Dmitry Frenkel

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

[diff] [blame]

1106

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1107

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1108

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1109

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1110

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1111

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

1112

},

1113

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1114

"sourceImage": "A String", # URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Dmitry Frenkel

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

[diff] [blame]

1115

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1116

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1117

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1118

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1119

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1120

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

1121

},

1122

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

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1123

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Dmitry Frenkel

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

[diff] [blame]

1124

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1125

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1126

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1127

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1128

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1129

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

1130

},

1131

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

1132

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

1133

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

1134

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

1135

"A String",

1136

],

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1137

"userLicenses": [ # A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch

1138

"A String",

1139

],

Bu Sun Kim

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

[diff] [blame]

1140

}

Dan O'Meara

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

[diff] [blame]

1141

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1142

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1143

x__xgafv: string, V1 error format.

1144

Allowed values

1145

1 - v1 error format

1146

2 - v2 error format

Dan O'Meara

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

[diff] [blame]

1147

1148

Returns:

1149

An object of the form:

1150

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1151

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1152

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

1153

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

1154

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

1155

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

1156

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

1157

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

Bu Sun Kim

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

[diff] [blame]

1158

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1159

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

1160

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

1161

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

Bu Sun Kim

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

[diff] [blame]

1162

},

1163

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1164

},

1165

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

1166

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

1167

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

1168

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

1169

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

yoshi-code-bot

2021-11-02 00:26:17 -0700

[diff] [blame^]

1170

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

1171

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

1172

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1173

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1174

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1175

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

1176

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

1177

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

1178

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

1179

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

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

1187

{

1188

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1189

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1190

{

1191

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

1192

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

1193

},

1194

],

1195

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

1196

},

1197

],

1198

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

1199

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1203

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1204

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

1205

1206

Args:

1207

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

Bu Sun Kim

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

[diff] [blame]

1208

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

Dan O'Meara

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

[diff] [blame]

1209

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1210

The object takes the form of:

1211

Bu Sun Kim

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

[diff] [blame]

1212

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1213

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

1214

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1215

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

1216

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1217

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

1218

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

1219

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

1220

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

1221

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1222

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1223

"A String",

1224

],

1225

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

Bu Sun Kim

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

[diff] [blame]

1226

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1227

],

1228

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

yoshi-code-bot

8bb904c

2021-08-31 00:28:27 -0700

[diff] [blame]

1229

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

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

[diff] [blame]

1230

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1231

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user: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" ] } ] } ] } 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]

1232

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1233

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1234

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

Bu Sun Kim

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

[diff] [blame]

1235

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1236

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1237

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1238

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1239

},

1240

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1241

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1242

"A String",

1243

],

1244

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1245

},

1246

],

Bu Sun Kim

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

[diff] [blame]

1247

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1248

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1249

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

1250

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

1251

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

1252

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

1253

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

1254

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

1255

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1256

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

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

[diff] [blame]

1257

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1258

],

Bu Sun Kim

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

[diff] [blame]

1259

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1260

},

1261

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1262

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1263

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

1264

"rules": [ # This is deprecated and has no effect. Do not use.

1265

{ # This is deprecated and has no effect. Do not use.

1266

"action": "A String", # This is deprecated and has no effect. Do not use.

1267

"conditions": [ # This is deprecated and has no effect. Do not use.

1268

{ # This is deprecated and has no effect. Do not use.

1269

"iam": "A String", # This is deprecated and has no effect. Do not use.

1270

"op": "A String", # This is deprecated and has no effect. Do not use.

1271

"svc": "A String", # This is deprecated and has no effect. Do not use.

1272

"sys": "A String", # This is deprecated and has no effect. Do not use.

1273

"values": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1278

"description": "A String", # This is deprecated and has no effect. Do not use.

1279

"ins": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1280

"A String",

1281

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1282

"logConfigs": [ # This is deprecated and has no effect. Do not use.

1283

{ # This is deprecated and has no effect. Do not use.

1284

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1285

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1286

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1287

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1288

"logName": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1289

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1290

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1291

"customFields": [ # This is deprecated and has no effect. Do not use.

1292

{ # This is deprecated and has no effect. Do not use.

1293

"name": "A String", # This is deprecated and has no effect. Do not use.

1294

"value": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1295

},

1296

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1297

"field": "A String", # This is deprecated and has no effect. Do not use.

1298

"metric": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1299

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1300

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1301

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1302

},

1303

},

1304

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1305

"notIns": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

1306

"A String",

1307

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1308

"permissions": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1313

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

}

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1317

x__xgafv: string, V1 error format.

1318

Allowed values

1319

1 - v1 error format

1320

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1321

1322

Returns:

1323

An object of the form:

1324

yoshi-code-bot

8bb904c

2021-08-31 00:28:27 -0700

[diff] [blame]

1325

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1326

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1327

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user: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" ] } ] } ] } 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1328

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1329

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1330

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1331

"A String",

1332

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1333

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1334

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

1335

},

1336

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1337

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1338

"A String",

1339

],

1340

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

1341

},

1342

],

1343

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

1344

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1345

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

1346

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1347

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

1348

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

1349

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

1350

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

1351

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1352

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1353

"A String",

1354

],

1355

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

1356

},

1357

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1358

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1359

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

1360

"rules": [ # This is deprecated and has no effect. Do not use.

1361

{ # This is deprecated and has no effect. Do not use.

1362

"action": "A String", # This is deprecated and has no effect. Do not use.

1363

"conditions": [ # This is deprecated and has no effect. Do not use.

1364

{ # This is deprecated and has no effect. Do not use.

1365

"iam": "A String", # This is deprecated and has no effect. Do not use.

1366

"op": "A String", # This is deprecated and has no effect. Do not use.

1367

"svc": "A String", # This is deprecated and has no effect. Do not use.

1368

"sys": "A String", # This is deprecated and has no effect. Do not use.

1369

"values": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1374

"description": "A String", # This is deprecated and has no effect. Do not use.

1375

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1376

"A String",

1377

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1378

"logConfigs": [ # This is deprecated and has no effect. Do not use.

1379

{ # This is deprecated and has no effect. Do not use.

1380

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1381

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1382

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1383

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1384

"logName": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1385

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1386

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1387

"customFields": [ # This is deprecated and has no effect. Do not use.

1388

{ # This is deprecated and has no effect. Do not use.

1389

"name": "A String", # This is deprecated and has no effect. Do not use.

1390

"value": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1391

},

1392

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1393

"field": "A String", # This is deprecated and has no effect. Do not use.

1394

"metric": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1395

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1396

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1397

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1398

},

1399

},

1400

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1401

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1402

"A String",

1403

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1404

"permissions": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1409

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1410

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1414

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

Bu Sun Kim

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

[diff] [blame]

1415

<pre>Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1416

1417

Args:

1418

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

Bu Sun Kim

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

[diff] [blame]

1419

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

Dan O'Meara

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

[diff] [blame]

1420

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1421

The object takes the form of:

1422

1423

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1424

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

1425

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

1426

"a_key": "A String",

1427

},

1428

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1429

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1430

x__xgafv: string, V1 error format.

1431

Allowed values

1432

1 - v1 error format

1433

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1434

1435

Returns:

1436

An object of the form:

1437

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1438

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1439

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

1440

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

1441

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

1442

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

1443

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

1444

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

Bu Sun Kim

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

[diff] [blame]

1445

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1446

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

1447

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

1448

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

Bu Sun Kim

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

[diff] [blame]

1449

},

1450

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1451

},

1452

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

1453

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

1454

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

1455

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

1456

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

yoshi-code-bot

2021-11-02 00:26:17 -0700

[diff] [blame^]

1457

"metadata": { # [Output Only] Service-specific metadata attached to this operation.

1458

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

1459

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1460

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1461

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1462

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

1463

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

1464

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

1465

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

1466

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1467

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

1468

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

1469

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

1470

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

1471

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

1472

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

1473

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

1474

{

1475

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1476

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot