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

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

Dan O'Meara

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

[diff] [blame]

105

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

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

108

<code><a href="#setIamPolicy">setIamPolicy(project, resource, body=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

Dan O'Meara

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

[diff] [blame]

111

<code><a href="#setLabels">setLabels(project, resource, body=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

Dan O'Meara

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

[diff] [blame]

114

<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=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>

Sai Cheemalapati

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

[diff] [blame]

123

<code class="details" id="delete">delete(project, image, requestId=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)

Bu Sun Kim

2019-06-14 16:50:42 -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.

130

131

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.

132

133

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

Sai Cheemalapati

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

[diff] [blame]

134

135

Returns:

136

An object of the form:

137

Bu Sun Kim

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

[diff] [blame]

138

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

139

#

140

# Google Compute Engine has three Operation resources:

141

#

142

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

143

#

144

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

145

#

146

# Operations can be global, regional or zonal.

147

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

148

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

149

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

150

#

151

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

152

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

153

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

154

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

155

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

156

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

157

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

Bu Sun Kim

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

[diff] [blame]

158

{

Yoshi Automation Bot

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

[diff] [blame]

159

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

160

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

161

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

Bu Sun Kim

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

[diff] [blame]

162

},

163

],

Yoshi Automation Bot

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

[diff] [blame]

164

},

165

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

166

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

167

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

168

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

169

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

yoshi-code-bot

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

[diff] [blame^]

170

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

171

#

172

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

173

#

174

# Example 1: Pack and unpack a message in C++.

175

#

176

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

177

#

178

# Example 2: Pack and unpack a message in Java.

179

#

180

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

181

#

182

# Example 3: Pack and unpack a message in Python.

183

#

184

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

185

#

186

# Example 4: Pack and unpack a message in Go

187

#

188

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

189

#

190

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

195

#

196

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

197

#

198

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

199

#

200

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

201

#

202

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

203

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

204

#

205

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

206

#

207

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

208

#

209

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

210

#

211

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

212

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

213

},

Yoshi Automation Bot

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

[diff] [blame]

214

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

yoshi-code-bot

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

[diff] [blame^]

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

{

229

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

230

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

231

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

232

{

233

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

234

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

235

},

236

],

237

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

238

},

239

],

240

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

241

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

245

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

Sai Cheemalapati

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

[diff] [blame]

246

<pre>Sets the deprecation status of an image.

247

248

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

249

250

Args:

251

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

252

image: string, Image name. (required)

Dan O'Meara

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

[diff] [blame]

253

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

254

The object takes the form of:

255

256

{ # Deprecation status for a public resource.

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

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

260

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

261

"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-03-02 11:49:08 -0800

[diff] [blame^]

262

"stateOverride": { # A rollout policy configuration. # The rollout policy of 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.

263

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

264

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

265

#

266

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

267

#

268

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

269

"a_key": "A String",

270

},

271

},

Sai Cheemalapati

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

[diff] [blame]

272

}

273

Bu Sun Kim

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

[diff] [blame]

274

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.

275

276

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.

277

278

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

Sai Cheemalapati

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

[diff] [blame]

279

280

Returns:

281

An object of the form:

282

Bu Sun Kim

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

[diff] [blame]

283

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

284

#

285

# Google Compute Engine has three Operation resources:

286

#

287

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

288

#

289

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

290

#

291

# Operations can be global, regional or zonal.

292

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

293

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

294

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

295

#

296

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

297

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

298

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

299

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

300

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

301

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

302

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

Bu Sun Kim

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

[diff] [blame]

303

{

Yoshi Automation Bot

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

[diff] [blame]

304

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

305

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

306

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

Bu Sun Kim

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

[diff] [blame]

307

},

308

],

Yoshi Automation Bot

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

[diff] [blame]

309

},

310

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

311

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

312

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

313

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

314

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

yoshi-code-bot

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

[diff] [blame^]

315

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

316

#

317

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

318

#

319

# Example 1: Pack and unpack a message in C++.

320

#

321

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

322

#

323

# Example 2: Pack and unpack a message in Java.

324

#

325

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

326

#

327

# Example 3: Pack and unpack a message in Python.

328

#

329

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

330

#

331

# Example 4: Pack and unpack a message in Go

332

#

333

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

334

#

335

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

340

#

341

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

342

#

343

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

344

#

345

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

346

#

347

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

348

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

349

#

350

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

351

#

352

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

353

#

354

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

355

#

356

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

357

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

358

},

Yoshi Automation Bot

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

[diff] [blame]

359

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

yoshi-code-bot

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

[diff] [blame^]

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

{

374

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

375

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

376

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

377

{

378

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

379

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

380

},

381

],

382

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

383

},

384

],

385

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

386

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

391

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

392

393

Args:

394

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

395

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

396

397

Returns:

398

An object of the form:

399

Bu Sun Kim

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

[diff] [blame]

400

{ # Represents an Image resource.

Yoshi Automation Bot

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

[diff] [blame]

401

#

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

"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-03-02 11:49:08 -0800

[diff] [blame^]

411

"stateOverride": { # A rollout policy configuration. # The rollout policy of 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.

412

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

413

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

414

#

415

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

416

#

417

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

418

"a_key": "A String",

419

},

420

},

Yoshi Automation Bot

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

[diff] [blame]

421

},

422

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

423

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

424

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

425

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

426

{ # Guest OS features.

427

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

428

},

429

],

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

#

Yoshi Automation Bot

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

[diff] [blame]

433

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

434

#

435

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

436

#

437

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

438

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

439

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

440

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

441

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

442

#

Yoshi Automation Bot

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

[diff] [blame]

443

# The key must meet the following requirements before you can provide it to Compute Engine:

444

# - The key is wrapped using a RSA public key certificate provided by Google.

445

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

446

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

447

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

448

},

449

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

450

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

451

#

452

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

453

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

454

"a_key": "A String",

455

},

456

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

457

"A String",

458

],

459

"licenses": [ # Any applicable license URI.

460

"A String",

461

],

462

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

463

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

464

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

465

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

466

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

467

},

yoshi-code-bot

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

[diff] [blame^]

468

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

469

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

470

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

471

#

472

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

473

#

474

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

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

479

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

480

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

481

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

482

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

483

{

Bu Sun Kim

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

[diff] [blame]

484

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

485

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

Bu Sun Kim

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

[diff] [blame]

486

},

Bu Sun Kim

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

[diff] [blame]

487

],

Yoshi Automation Bot

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

[diff] [blame]

488

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

489

{

490

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

491

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

492

},

493

],

494

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

495

{

496

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

497

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

498

},

499

],

500

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

501

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

502

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

503

},

504

},

505

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

506

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

507

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

508

# - zones/zone/disks/disk

509

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

510

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

511

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

512

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

513

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

514

#

515

# The key must meet the following requirements before you can provide it to Compute Engine:

516

# - The key is wrapped using a RSA public key certificate provided by Google.

517

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

518

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

519

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

520

},

521

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

522

"sourceImage": "A String", # URL of the source image used to create this image.

523

#

524

# In order to create an image, you must provide the full or partial URL of one of the following:

525

# - The selfLink URL

526

# - This property

527

# - The rawDisk.source URL

528

# - The sourceDisk URL

529

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

530

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

531

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

532

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

533

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

534

#

535

# The key must meet the following requirements before you can provide it to Compute Engine:

536

# - The key is wrapped using a RSA public key certificate provided by Google.

537

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

538

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

539

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

540

},

541

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

542

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image.

543

#

544

# In order to create an image, you must provide the full or partial URL of one of the following:

545

# - The selfLink URL

546

# - This property

547

# - The sourceImage URL

548

# - The rawDisk.source URL

549

# - The sourceDisk URL

550

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

551

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

552

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

553

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

554

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

555

#

556

# The key must meet the following requirements before you can provide it to Compute Engine:

557

# - The key is wrapped using a RSA public key certificate provided by Google.

558

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

559

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

560

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

561

},

562

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

563

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

564

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

565

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

566

"A String",

567

],

568

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

573

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

574

575

Args:

576

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

577

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

578

579

Returns:

580

An object of the form:

581

Bu Sun Kim

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

[diff] [blame]

582

{ # Represents an Image resource.

Yoshi Automation Bot

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

[diff] [blame]

583

#

584

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

585

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

586

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

587

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

588

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

589

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

590

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

591

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

592

"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-03-02 11:49:08 -0800

[diff] [blame^]

593

"stateOverride": { # A rollout policy configuration. # The rollout policy of 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.

594

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

595

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

596

#

597

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

598

#

599

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

600

"a_key": "A String",

601

},

602

},

Yoshi Automation Bot

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

[diff] [blame]

603

},

604

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

605

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

606

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

607

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

608

{ # Guest OS features.

609

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

610

},

611

],

612

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

613

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

Bu Sun Kim

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

[diff] [blame]

614

#

Yoshi Automation Bot

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

[diff] [blame]

615

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

616

#

617

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

618

#

619

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

620

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

621

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

622

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

623

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

624

#

Yoshi Automation Bot

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

[diff] [blame]

625

# The key must meet the following requirements before you can provide it to Compute Engine:

626

# - The key is wrapped using a RSA public key certificate provided by Google.

627

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

628

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

629

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

630

},

631

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

632

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

633

#

634

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

635

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

636

"a_key": "A String",

637

},

638

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

639

"A String",

640

],

641

"licenses": [ # Any applicable license URI.

642

"A String",

643

],

644

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

645

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

646

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

647

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

648

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

649

},

yoshi-code-bot

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

[diff] [blame^]

650

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

651

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

652

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

653

#

654

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

655

#

656

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

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

661

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

662

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

663

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

664

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

665

{

Bu Sun Kim

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

[diff] [blame]

666

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

667

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

Bu Sun Kim

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

[diff] [blame]

668

},

Bu Sun Kim

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

[diff] [blame]

669

],

Yoshi Automation Bot

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

[diff] [blame]

670

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

671

{

672

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

673

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

674

},

675

],

676

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

677

{

678

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

679

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

680

},

681

],

682

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

683

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

684

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

685

},

686

},

687

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

688

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

689

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

690

# - zones/zone/disks/disk

691

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

692

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

693

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

694

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

695

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

696

#

697

# The key must meet the following requirements before you can provide it to Compute Engine:

698

# - The key is wrapped using a RSA public key certificate provided by Google.

699

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

700

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

701

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

702

},

703

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

704

"sourceImage": "A String", # URL of the source image used to create this image.

705

#

706

# In order to create an image, you must provide the full or partial URL of one of the following:

707

# - The selfLink URL

708

# - This property

709

# - The rawDisk.source URL

710

# - The sourceDisk URL

711

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

712

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

713

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

714

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

715

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

716

#

717

# The key must meet the following requirements before you can provide it to Compute Engine:

718

# - The key is wrapped using a RSA public key certificate provided by Google.

719

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

720

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

721

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

722

},

723

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

724

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image.

725

#

726

# In order to create an image, you must provide the full or partial URL of one of the following:

727

# - The selfLink URL

728

# - This property

729

# - The sourceImage URL

730

# - The rawDisk.source URL

731

# - The sourceDisk URL

732

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

733

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

734

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

735

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

736

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

737

#

738

# The key must meet the following requirements before you can provide it to Compute Engine:

739

# - The key is wrapped using a RSA public key certificate provided by Google.

740

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

741

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

742

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

743

},

744

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

745

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

746

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

747

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

748

"A String",

749

],

750

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

754

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

Sai Cheemalapati

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

[diff] [blame]

755

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

756

757

Args:

758

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

Bu Sun Kim

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

[diff] [blame]

759

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

Dan O'Meara

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

[diff] [blame]

760

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

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

[diff] [blame]

761

762

Returns:

763

An object of the form:

764

Dan O'Meara

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

[diff] [blame]

765

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

Yoshi Automation Bot

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

[diff] [blame]

#

#

#

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

770

#

771

# 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

780

#

781

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

782

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

783

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

784

#

785

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

786

#

787

# Example Policy with multiple AuditConfigs:

788

#

789

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

790

#

791

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

792

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

793

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

Bu Sun Kim

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

[diff] [blame]

794

#

Yoshi Automation Bot

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

[diff] [blame]

795

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

Bu Sun Kim

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

[diff] [blame]

796

#

Yoshi Automation Bot

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

[diff] [blame]

797

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

798

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

799

"A String",

800

],

801

"ignoreChildExemptions": True or False,

802

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

Bu Sun Kim

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

[diff] [blame]

803

},

Yoshi Automation Bot

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

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

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

809

},

810

],

811

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

812

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

813

"bindingId": "A String",

814

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

815

#

816

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

817

#

818

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

819

#

820

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

821

#

822

# Example (Comparison):

823

#

824

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

825

#

826

# Example (Equality):

827

#

828

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

833

#

834

# Example (Data Manipulation):

835

#

836

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

837

#

838

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

839

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

840

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

841

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

842

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

843

},

Yoshi Automation Bot

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

[diff] [blame]

844

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

845

#

846

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

847

#

848

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

849

#

850

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

855

#

856

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

857

#

858

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

859

#

860

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

861

#

862

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

867

"A String",

868

],

869

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

870

},

871

],

872

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

873

#

874

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

875

"iamOwned": True or False,

876

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

877

{ # A rule to be applied in a Policy.

878

"action": "A String", # Required

879

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

880

{ # A condition to be met.

881

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

882

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

883

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

884

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

885

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

"A String",

],

},

],

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

891

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

892

"A String",

893

],

894

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

895

{ # Specifies what kind of log the caller must write

896

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

897

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

898

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

899

},

900

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

Bu Sun Kim

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

[diff] [blame]

901

},

Yoshi Automation Bot

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

[diff] [blame]

902

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

903

#

904

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

905

#

906

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

907

#

908

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

909

#

910

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

911

"customFields": [ # Custom fields.

912

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

913

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

914

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

Bu Sun Kim

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

[diff] [blame]

915

},

Yoshi Automation Bot

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

[diff] [blame]

916

],

917

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

918

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

Bu Sun Kim

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

[diff] [blame]

919

},

Yoshi Automation Bot

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

[diff] [blame]

920

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

921

"logMode": "A String",

},

},

],

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

926

"A String",

927

],

928

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

"A String",

],

},

],

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

934

#

935

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

936

#

937

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

938

#

939

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

940

#

941

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

942

#

943

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

944

#

945

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

946

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

950

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

Sai Cheemalapati

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

[diff] [blame]

951

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

952

953

Args:

954

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

Dan O'Meara

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

[diff] [blame]

955

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

956

The object takes the form of:

957

Bu Sun Kim

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

[diff] [blame]

958

{ # Represents an Image resource.

Bu Sun Kim

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

[diff] [blame]

959

#

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

"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-03-02 11:49:08 -0800

[diff] [blame^]

969

"stateOverride": { # A rollout policy configuration. # The rollout policy of 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.

970

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

971

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

972

#

973

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

974

#

975

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

976

"a_key": "A String",

977

},

978

},

Bu Sun Kim

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

[diff] [blame]

979

},

980

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

981

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

982

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

983

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

984

{ # Guest OS features.

985

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

986

},

987

],

988

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

Dmitry Frenkel

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

[diff] [blame]

989

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

Bu Sun Kim

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

[diff] [blame]

990

#

Bu Sun Kim

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

[diff] [blame]

991

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

992

#

993

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

994

#

995

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

996

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

997

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

998

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

999

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1000

#

1001

# The key must meet the following requirements before you can provide it to Compute Engine:

1002

# - The key is wrapped using a RSA public key certificate provided by Google.

1003

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1004

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1005

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

1006

},

1007

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

1008

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

1009

#

1010

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

1011

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

1012

"a_key": "A String",

1013

},

1014

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

1015

"A String",

1016

],

1017

"licenses": [ # Any applicable license URI.

1018

"A String",

1019

],

1020

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

1021

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

1022

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

1023

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

1024

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

1025

},

yoshi-code-bot

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

[diff] [blame^]

1026

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

1027

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

1028

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

1029

#

1030

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

1031

#

1032

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

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

1037

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

1038

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

1039

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

1040

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

1041

{

1042

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

1043

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

Sai Cheemalapati

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

[diff] [blame]

1044

},

1045

],

Bu Sun Kim

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

[diff] [blame]

1046

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

1047

{

1048

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

1049

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

Bu Sun Kim

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

[diff] [blame]

1050

},

Bu Sun Kim

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

[diff] [blame]

1051

],

1052

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

1053

{

1054

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

1055

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

1056

},

1057

],

1058

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

1059

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

1060

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

Bu Sun Kim

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

[diff] [blame]

1061

},

Bu Sun Kim

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

[diff] [blame]

1062

},

1063

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

1064

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

1065

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

1066

# - zones/zone/disks/disk

Dmitry Frenkel

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

[diff] [blame]

1067

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

Bu Sun Kim

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

[diff] [blame]

1068

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

1069

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

1070

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

1071

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1072

#

1073

# The key must meet the following requirements before you can provide it to Compute Engine:

1074

# - The key is wrapped using a RSA public key certificate provided by Google.

1075

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1076

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1077

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

1078

},

1079

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1080

"sourceImage": "A String", # URL of the source image used to create this image.

1081

#

1082

# In order to create an image, you must provide the full or partial URL of one of the following:

1083

# - The selfLink URL

1084

# - This property

1085

# - The rawDisk.source URL

1086

# - The sourceDisk URL

Dmitry Frenkel

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

[diff] [blame]

1087

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

Bu Sun Kim

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

[diff] [blame]

1088

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

1089

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

1090

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

1091

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1092

#

1093

# The key must meet the following requirements before you can provide it to Compute Engine:

1094

# - The key is wrapped using a RSA public key certificate provided by Google.

1095

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1096

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1097

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

1098

},

1099

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1100

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image.

1101

#

1102

# In order to create an image, you must provide the full or partial URL of one of the following:

1103

# - The selfLink URL

1104

# - This property

1105

# - The sourceImage URL

1106

# - The rawDisk.source URL

1107

# - The sourceDisk URL

Dmitry Frenkel

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

[diff] [blame]

1108

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

Bu Sun Kim

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

[diff] [blame]

1109

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

1110

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

1111

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

1112

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1113

#

1114

# The key must meet the following requirements before you can provide it to Compute Engine:

1115

# - The key is wrapped using a RSA public key certificate provided by Google.

1116

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1117

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1118

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

1119

},

1120

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

1121

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

1122

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

1123

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

1124

"A String",

1125

],

1126

}

Sai Cheemalapati

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

[diff] [blame]

1127

Bu Sun Kim

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

[diff] [blame]

1128

forceCreate: boolean, Force image creation if true.

Bu Sun Kim

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

[diff] [blame]

1129

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.

1130

1131

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.

1132

1133

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

Sai Cheemalapati

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

[diff] [blame]

1134

1135

Returns:

1136

An object of the form:

1137

Bu Sun Kim

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

[diff] [blame]

1138

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1139

#

1140

# Google Compute Engine has three Operation resources:

1141

#

1142

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

1143

#

1144

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

1145

#

1146

# Operations can be global, regional or zonal.

1147

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

1148

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

1149

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

1150

#

1151

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

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-03-02 11:49:08 -0800

[diff] [blame^]

1170

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1171

#

1172

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1173

#

1174

# Example 1: Pack and unpack a message in C++.

1175

#

1176

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1177

#

1178

# Example 2: Pack and unpack a message in Java.

1179

#

1180

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1181

#

1182

# Example 3: Pack and unpack a message in Python.

1183

#

1184

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1185

#

1186

# Example 4: Pack and unpack a message in Go

1187

#

1188

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1189

#

1190

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1195

#

1196

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1197

#

1198

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1199

#

1200

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1201

#

1202

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1203

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1204

#

1205

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1206

#

1207

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1208

#

1209

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1210

#

1211

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1212

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1213

},

Yoshi Automation Bot

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

[diff] [blame]

1214

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

yoshi-code-bot

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

[diff] [blame^]

1215

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

1216

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

1217

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

1218

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

1219

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

1220

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

1221

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

1222

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

1223

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

1224

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

1225

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

1226

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

1227

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

1228

{

1229

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

1230

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

1231

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

1232

{

1233

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

1234

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

1235

},

1236

],

1237

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

1238

},

1239

],

1240

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

1241

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame^]

1245

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

Bu Sun Kim

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

[diff] [blame]

1246

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

1247

1248

Args:

1249

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

Dan O'Meara

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

[diff] [blame]

1250

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

Sai Cheemalapati

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

[diff] [blame]

1251

Dan O'Meara

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

[diff] [blame]

1252

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

Sai Cheemalapati

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

[diff] [blame]

1253

Dan O'Meara

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

[diff] [blame]

1254

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.

Sai Cheemalapati

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

[diff] [blame]

1255

Bu Sun Kim

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

[diff] [blame]

1256

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

1257

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

1258

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

1259

1260

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.

1261

1262

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

1263

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

1264

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

1265

zone: string, The zone query parameter.

Sai Cheemalapati

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

[diff] [blame]

1266

1267

Returns:

1268

An object of the form:

1269

1270

{ # Contains a list of images.

Yoshi Automation Bot

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

[diff] [blame]

1271

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

1272

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

1273

{ # Represents an Image resource.

1274

#

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

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

1283

"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-03-02 11:49:08 -0800

[diff] [blame^]

1284

"stateOverride": { # A rollout policy configuration. # The rollout policy of 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.

1285

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

1286

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

1287

#

1288

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

1289

#

1290

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

1291

"a_key": "A String",

1292

},

1293

},

Yoshi Automation Bot

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

[diff] [blame]

1294

},

1295

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

1296

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

1297

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

1298

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

1299

{ # Guest OS features.

1300

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

1301

},

1302

],

1303

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

1304

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

Bu Sun Kim

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

[diff] [blame]

1305

#

Yoshi Automation Bot

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

[diff] [blame]

1306

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

1307

#

1308

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

1309

#

1310

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

1311

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

1312

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

1313

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

1314

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

1315

#

Yoshi Automation Bot

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

[diff] [blame]

1316

# The key must meet the following requirements before you can provide it to Compute Engine:

1317

# - The key is wrapped using a RSA public key certificate provided by Google.

1318

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1319

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1320

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

1321

},

1322

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

1323

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

1324

#

1325

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

1326

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

1327

"a_key": "A String",

1328

},

1329

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

1330

"A String",

1331

],

1332

"licenses": [ # Any applicable license URI.

1333

"A String",

1334

],

1335

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

1336

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

1337

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

1338

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

1339

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

1340

},

yoshi-code-bot

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

[diff] [blame^]

1341

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

1342

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

1343

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

1344

#

1345

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

1346

#

1347

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

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

1352

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

1353

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

1354

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

1355

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

1356

{

Bu Sun Kim

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

[diff] [blame]

1357

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

1358

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

1359

},

Bu Sun Kim

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

[diff] [blame]

1360

],

Yoshi Automation Bot

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

[diff] [blame]

1361

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

1362

{

1363

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

1364

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

1365

},

1366

],

1367

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

1368

{

1369

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

1370

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

1371

},

1372

],

1373

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

1374

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

1375

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

1376

},

1377

},

1378

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

1379

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

1380

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

1381

# - zones/zone/disks/disk

1382

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

1383

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

1384

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

1385

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

1386

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1387

#

1388

# The key must meet the following requirements before you can provide it to Compute Engine:

1389

# - The key is wrapped using a RSA public key certificate provided by Google.

1390

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1391

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1392

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

1393

},

1394

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

1395

"sourceImage": "A String", # URL of the source image used to create this image.

1396

#

1397

# In order to create an image, you must provide the full or partial URL of one of the following:

1398

# - The selfLink URL

1399

# - This property

1400

# - The rawDisk.source URL

1401

# - The sourceDisk URL

1402

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

1403

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

1404

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

1405

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

1406

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1407

#

1408

# The key must meet the following requirements before you can provide it to Compute Engine:

1409

# - The key is wrapped using a RSA public key certificate provided by Google.

1410

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1411

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1412

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

1413

},

1414

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

1415

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image.

1416

#

1417

# In order to create an image, you must provide the full or partial URL of one of the following:

1418

# - The selfLink URL

1419

# - This property

1420

# - The sourceImage URL

1421

# - The rawDisk.source URL

1422

# - The sourceDisk URL

1423

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

1424

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

1425

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

1426

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

1427

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1428

#

1429

# The key must meet the following requirements before you can provide it to Compute Engine:

1430

# - The key is wrapped using a RSA public key certificate provided by Google.

1431

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1432

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1433

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

1434

},

1435

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

1436

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

1437

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

1438

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

"A String",

],

},

],

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

1444

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

1445

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

1446

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

1447

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

1448

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

1449

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

1450

{

1451

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

1452

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

1453

},

Sai Cheemalapati

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

[diff] [blame]

1454

],

Yoshi Automation Bot

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

[diff] [blame]

1455

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

1456

},

1457

}</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>

1462

<pre>Retrieves the next page of results.

1463

1464

Args:

1465

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

1466

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

1467

1468

Returns:

Bu Sun Kim

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

[diff] [blame]

1469

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

Sai Cheemalapati

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

[diff] [blame]

1470

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1475

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

1476

<pre>Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

1477

1478

Args:

1479

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

1480

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

1481

body: object, The request body.

1482

The object takes the form of:

1483

1484

{ # Represents an Image resource.

Bu Sun Kim

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

[diff] [blame]

1485

#

1486

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

"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-03-02 11:49:08 -0800

[diff] [blame^]

1495

"stateOverride": { # A rollout policy configuration. # The rollout policy of 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.

1496

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

1497

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

1498

#

1499

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

1500

#

1501

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

1502

"a_key": "A String",

1503

},

1504

},

Bu Sun Kim

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

[diff] [blame]

1505

},

1506

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

1507

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

1508

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

1509

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

1510

{ # Guest OS features.

1511

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

1512

},

1513

],

1514

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

Dmitry Frenkel

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

[diff] [blame]

1515

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

Dan O'Meara

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

[diff] [blame]

1516

#

Bu Sun Kim

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

[diff] [blame]

1517

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

1518

#

1519

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

1520

#

1521

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

1522

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

1523

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

1524

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

1525

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1526

#

1527

# The key must meet the following requirements before you can provide it to Compute Engine:

1528

# - The key is wrapped using a RSA public key certificate provided by Google.

1529

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1530

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1531

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

1532

},

1533

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

1534

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

1535

#

1536

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

1537

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

1538

"a_key": "A String",

1539

},

1540

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

1541

"A String",

1542

],

1543

"licenses": [ # Any applicable license URI.

1544

"A String",

1545

],

1546

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

1547

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

1548

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

1549

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

1550

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

1551

},

yoshi-code-bot

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

[diff] [blame^]

1552

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

1553

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

1554

"locationRolloutPolicies": { # Location based rollout policies to apply to the resource.

1555

#

1556

# Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a.

1557

#

1558

# The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location.

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

1563

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

1564

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

1565

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

1566

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

1567

{

1568

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

1569

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

Dan O'Meara

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

[diff] [blame]

1570

},

1571

],

Bu Sun Kim

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

[diff] [blame]

1572

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

1573

{

1574

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

1575

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

Dan O'Meara

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

[diff] [blame]

1576

},

Bu Sun Kim

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

[diff] [blame]

1577

],

1578

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

1579

{

1580

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

1581

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

1582

},

1583

],

1584

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

1585

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

1586

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

Dan O'Meara

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

[diff] [blame]

1587

},

Bu Sun Kim

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

[diff] [blame]

1588

},

1589

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

1590

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

1591

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

1592

# - zones/zone/disks/disk

Dmitry Frenkel

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

[diff] [blame]

1593

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

Bu Sun Kim

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

[diff] [blame]

1594

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

1595

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

1596

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

1597

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1598

#

1599

# The key must meet the following requirements before you can provide it to Compute Engine:

1600

# - The key is wrapped using a RSA public key certificate provided by Google.

1601

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1602

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1603

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

1604

},

1605

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1606

"sourceImage": "A String", # URL of the source image used to create this image.

1607

#

1608

# In order to create an image, you must provide the full or partial URL of one of the following:

1609

# - The selfLink URL

1610

# - This property

1611

# - The rawDisk.source URL

1612

# - The sourceDisk URL

Dmitry Frenkel

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

[diff] [blame]

1613

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

Bu Sun Kim

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

[diff] [blame]

1614

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

1615

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

1616

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

1617

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1618

#

1619

# The key must meet the following requirements before you can provide it to Compute Engine:

1620

# - The key is wrapped using a RSA public key certificate provided by Google.

1621

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1622

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1623

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

1624

},

1625

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1626

"sourceSnapshot": "A String", # URL of the source snapshot used to create this image.

1627

#

1628

# In order to create an image, you must provide the full or partial URL of one of the following:

1629

# - The selfLink URL

1630

# - This property

1631

# - The sourceImage URL

1632

# - The rawDisk.source URL

1633

# - The sourceDisk URL

Dmitry Frenkel

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

[diff] [blame]

1634

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

Bu Sun Kim

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

[diff] [blame]

1635

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

1636

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

1637

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

1638

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1639

#

1640

# The key must meet the following requirements before you can provide it to Compute Engine:

1641

# - The key is wrapped using a RSA public key certificate provided by Google.

1642

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1643

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1644

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

1645

},

1646

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

1647

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

1648

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

1649

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

1650

"A String",

1651

],

1652

}

Dan O'Meara

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

[diff] [blame]

1653

1654

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.

1655

1656

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.

1657

1658

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

1659

1660

Returns:

1661

An object of the form:

1662

1663

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1664

#

1665

# Google Compute Engine has three Operation resources:

1666

#

1667

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

1668

#

1669

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

1670

#

1671

# Operations can be global, regional or zonal.

1672

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

1673

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

1674

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

1675

#

1676

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

1677

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

1678

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

1679

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

1680

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

1681

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

1682

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

Bu Sun Kim

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

[diff] [blame]

1683

{

Yoshi Automation Bot

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

[diff] [blame]

1684

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

1685

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

1686

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

Bu Sun Kim

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

[diff] [blame]

1687

},

1688

],

Yoshi Automation Bot

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

[diff] [blame]

1689

},

1690

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

1691

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

1692

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

1693

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

1694

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

yoshi-code-bot

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

[diff] [blame^]

1695

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

1696

#

1697

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

1698

#

1699

# Example 1: Pack and unpack a message in C++.

1700

#

1701

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

1702

#

1703

# Example 2: Pack and unpack a message in Java.

1704

#

1705

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

1706

#

1707

# Example 3: Pack and unpack a message in Python.

1708

#

1709

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

1710

#

1711

# Example 4: Pack and unpack a message in Go

1712

#

1713

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

1714

#

1715

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

1720

#

1721

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

1722

#

1723

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

1724

#

1725

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

1726

#

1727

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

1728

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

1729

#

1730

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

1731

#

1732

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

1733

#

1734

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

1735

#

1736

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

1737

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

1738

},

Yoshi Automation Bot

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

[diff] [blame]

1739

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

1740

"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]

1741

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1742

"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.

1743

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1744

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1745

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1746

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1747

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1748

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1749

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1750

"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.

1751

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1752

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1753

{

1754

"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.

1755

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1756

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1757

{

1758

"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).

1759

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1760

},

1761

],

1762

"message": "A String", # [Output Only] A human-readable description of the warning code.

1763

},

1764

],

1765

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1766

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1771

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

1772

1773

Args:

1774

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1775

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1776

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1777

The object takes the form of:

1778

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1779

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1780

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1781

{ # Associates `members` with a `role`.

1782

"bindingId": "A String",

1783

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1784

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1785

# If the condition evaluates to `true`, then this binding applies to the current request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1786

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1787

# 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1788

#

1789

# 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]

1790

#

1791

# Example (Comparison):

1792

#

1793

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1794

#

1795

# Example (Equality):

1796

#

1797

# 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'"

1802

#

1803

# Example (Data Manipulation):

1804

#

1805

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1806

#

1807

# 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.

1808

"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.

1809

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1810

"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.

1811

"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.

1812

},

1813

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1814

#

1815

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1816

#

1817

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1818

#

1819

# * `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`.

1824

#

1825

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1826

#

1827

# * `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.

1828

#

1829

# * `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.

1830

#

1831

# * `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`.

1836

"A String",

1837

],

1838

"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]

1839

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1840

],

1841

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1842

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1843

#

1844

#

1845

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1846

# 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1847

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1848

# 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).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1849

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1850

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1851

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1852

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1853

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1854

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1855

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1856

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1857

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1858

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1859

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1860

{ # 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1861

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1862

# 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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1863

#

1864

# Example Policy with multiple AuditConfigs:

1865

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1866

# { "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" ] } ] } ] }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1867

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1868

# 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]

1869

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1870

{ # Provides the configuration for logging a type of permissions. Example:

1871

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1872

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1873

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1874

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1875

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1876

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1877

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"ignoreChildExemptions": True or False,

1879

"logType": "A String", # The log type that this config enables.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1880

},

1881

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1886

},

1887

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1888

"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]

1889

{ # Associates `members` with a `role`.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

1890

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1891

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

1892

#

1893

# If the condition evaluates to `true`, then this binding applies to the current request.

1894

#

1895

# 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.

1896

#

1897

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1898

#

1899

# Example (Comparison):

1900

#

1901

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1902

#

1903

# Example (Equality):

1904

#

1905

# 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'"

1910

#

1911

# Example (Data Manipulation):

1912

#

1913

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1914

#

1915

# 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.

1916

"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.

1917

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1918

"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.

1919

"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.

1920

},

1921

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1922

#

1923

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1924

#

1925

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1926

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1927

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1932

#

1933

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1934

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1935

# * `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.

1936

#

1937

# * `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.

1938

#

1939

# * `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.

1940

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1941

#

1942

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1943

# * `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]

1944

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1945

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1946

"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]

1947

},

1948

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1949

"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.

1950

#

1951

# **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.

1952

"iamOwned": True or False,

1953

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

1954

{ # A rule to be applied in a Policy.

1955

"action": "A String", # Required

1956

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1957

{ # A condition to be met.

1958

"iam": "A String", # Trusted attributes supplied by the IAM system.

1959

"op": "A String", # An operator to apply the subject with.

1960

"svc": "A String", # Trusted attributes discharged by the service.

1961

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1962

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1968

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

1969

"A String",

1970

],

1971

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1972

{ # Specifies what kind of log the caller must write

1973

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1974

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1975

"permissionType": "A String", # The type of the permission that was checked.

1976

},

1977

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1978

},

1979

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1980

#

1981

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

1982

#

1983

# Field names correspond to IAM request parameters and field values are their respective values.

1984

#

1985

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

1986

#

1987

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1988

"customFields": [ # Custom fields.

1989

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1990

"name": "A String", # Name is the field name.

1991

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

1992

},

1993

],

1994

"field": "A String", # The field value to attribute.

1995

"metric": "A String", # The metric to update.

1996

},

1997

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1998

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2003

"A String",

2004

],

2005

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2011

#

2012

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2013

#

2014

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2015

#

2016

# * 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

2017

#

2018

# **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.

2019

#

2020

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2021

#

2022

# 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]

},

}

Returns:

An object of the form:

2029

2030

{ # 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.

2035

#

2036

# 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

2045

#

2046

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

2047

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2048

{ # 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.

2049

#

2050

# 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.

2051

#

2052

# Example Policy with multiple AuditConfigs:

2053

#

2054

# { "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" ] } ] } ] }

2055

#

2056

# 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.

2057

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2058

{ # Provides the configuration for logging a type of permissions. Example:

2059

#

2060

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

2061

#

2062

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2063

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2064

"A String",

2065

],

2066

"ignoreChildExemptions": True or False,

2067

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

2074

},

2075

],

2076

"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.

2077

{ # Associates `members` with a `role`.

2078

"bindingId": "A String",

2079

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

2080

#

2081

# If the condition evaluates to `true`, then this binding applies to the current request.

2082

#

2083

# 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.

2084

#

2085

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2086

#

2087

# Example (Comparison):

2088

#

2089

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2090

#

2091

# Example (Equality):

2092

#

2093

# 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'"

2098

#

2099

# Example (Data Manipulation):

2100

#

2101

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2102

#

2103

# 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.

2104

"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.

2105

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2106

"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.

2107

"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.

2108

},

2109

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

2110

#

2111

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2112

#

2113

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2114

#

2115

# * `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`.

2120

#

2121

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2122

#

2123

# * `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.

2124

#

2125

# * `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.

2126

#

2127

# * `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`.

2132

"A String",

2133

],

2134

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2135

},

2136

],

2137

"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.

2138

#

2139

# **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.

2140

"iamOwned": True or False,

2141

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

2142

{ # A rule to be applied in a Policy.

2143

"action": "A String", # Required

2144

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2145

{ # A condition to be met.

2146

"iam": "A String", # Trusted attributes supplied by the IAM system.

2147

"op": "A String", # An operator to apply the subject with.

2148

"svc": "A String", # Trusted attributes discharged by the service.

2149

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2150

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2156

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2157

"A String",

2158

],

2159

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2160

{ # Specifies what kind of log the caller must write

2161

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2162

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2163

"permissionType": "A String", # The type of the permission that was checked.

2164

},

2165

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

2166

},

2167

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2168

#

2169

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

2170

#

2171

# Field names correspond to IAM request parameters and field values are their respective values.

2172

#

2173

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

2174

#

2175

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2176

"customFields": [ # Custom fields.

2177

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2178

"name": "A String", # Name is the field name.

2179

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

2180

},

2181

],

2182

"field": "A String", # The field value to attribute.

2183

"metric": "A String", # The metric to update.

2184

},

2185

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2186

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2191

"A String",

2192

],

2193

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2199

#

2200

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2201

#

2202

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2203

#

2204

# * 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

2205

#

2206

# **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.

2207

#

2208

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2209

#

2210

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2211

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2215

<code class="details" id="setLabels">setLabels(project, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2216

<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]

2217

2218

Args:

2219

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2220

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2221

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2222

The object takes the form of:

2223

2224

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2225

"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.

2226

"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": "").

2227

"a_key": "A String",

2228

},

2229

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

2234

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2235

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2236

#

2237

# Google Compute Engine has three Operation resources:

2238

#

2239

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2240

#

2241

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2242

#

2243

# Operations can be global, regional or zonal.

2244

# - For global operations, use the `globalOperations` resource.

2245

# - For regional operations, use the `regionOperations` resource.

2246

# - For zonal operations, use the `zonalOperations` resource.

2247

#

2248

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2249

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2250

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2251

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2252

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2253

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2254

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2255

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2256

"code": "A String", # [Output Only] The error type identifier for this error.

2257

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2258

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2259

},

2260

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2261

},

2262

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2263

"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.

2264

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2265

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2266

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

2267

"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.

2268

#

2269

# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

2270

#

2271

# Example 1: Pack and unpack a message in C++.

2272

#

2273

# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

2274

#

2275

# Example 2: Pack and unpack a message in Java.

2276

#

2277

# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }

2278

#

2279

# Example 3: Pack and unpack a message in Python.

2280

#

2281

# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

2282

#

2283

# Example 4: Pack and unpack a message in Go

2284

#

2285

# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

2286

#

2287

# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

#

#

#

# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:

2292

#

2293

# package google.profile; message Person { string first_name = 1; string last_name = 2; }

2294

#

2295

# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

2296

#

2297

# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):

2298

#

2299

# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

2300

"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).

2301

#

2302

# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

2303

#

2304

# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

2305

#

2306

# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

2307

#

2308

# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.

2309

"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.

2310

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2311

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame^]

2312

"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