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

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

[diff] [blame]

81

<code><a href="#createSnapshot">createSnapshot(project, region, disk, body=None, guestFlush=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

82

<p class="firstline">Creates a snapshot of this regional disk.</p>

83

Sai Cheemalapati

c30d2b5

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

[diff] [blame]

84

<code><a href="#delete">delete(project, region, disk, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

85

<p class="firstline">Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p>

86

87

<code><a href="#get">get(project, region, disk)</a></code></p>

88

<p class="firstline">Returns a specified regional persistent disk.</p>

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists.</p>

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#insert">insert(project, region, body=None, requestId=None, sourceImage=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

94

<p class="firstline">Creates a persistent regional disk in the specified project using the data included in the request.</p>

95

Bu Sun Kim

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

[diff] [blame]

96

<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

97

<p class="firstline">Retrieves the list of persistent disks contained within the specified region.</p>

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

<code><a href="#removeResourcePolicies">removeResourcePolicies(project, region, disk, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

103

<p class="firstline">Removes resource policies from a regional disk.</p>

104

Dan O'Meara

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

[diff] [blame]

105

<code><a href="#resize">resize(project, region, disk, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

106

<p class="firstline">Resizes the specified regional persistent disk.</p>

107

Dan O'Meara

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

[diff] [blame]

108

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

Bu Sun Kim

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

[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, region, resource, body=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

112

<p class="firstline">Sets the labels on the target regional disk.</p>

113

Dan O'Meara

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

[diff] [blame]

114

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

Dan O'Meara

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

[diff] [blame]

118

<code class="details" id="addResourcePolicies">addResourcePolicies(project, region, disk, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

119

<pre>Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

Sai Cheemalapati

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

[diff] [blame]

120

121

Args:

122

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

Bu Sun Kim

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

[diff] [blame]

123

region: string, The name of the region for this request. (required)

124

disk: string, The disk name for this request. (required)

Dan O'Meara

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

[diff] [blame]

125

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

126

The object takes the form of:

127

Bu Sun Kim

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

[diff] [blame]

128

{

Bu Sun Kim

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

[diff] [blame]

129

"resourcePolicies": [ # Resource policies to be added to this disk.

130

"A String",

Sai Cheemalapati

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

[diff] [blame]

131

],

Sai Cheemalapati

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

[diff] [blame]

132

}

133

Bu Sun Kim

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

[diff] [blame]

134

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.

135

136

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.

137

138

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]

139

140

Returns:

141

An object of the form:

142

Bu Sun Kim

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

[diff] [blame]

143

{ # Represents an Operation resource.

144

#

Dan O'Meara

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

[diff] [blame]

145

# Google Compute Engine has three Operation resources:

146

#

147

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

148

#

Bu Sun Kim

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

[diff] [blame]

149

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

150

#

151

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

152

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

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

#

Dan O'Meara

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

[diff] [blame]

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

158

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

159

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

160

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

161

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

162

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

Bu Sun Kim

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

[diff] [blame]

163

{

Bu Sun Kim

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

[diff] [blame]

164

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

165

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

166

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

Bu Sun Kim

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

[diff] [blame]

167

},

168

],

169

},

Bu Sun Kim

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

[diff] [blame]

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

{

189

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

190

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

191

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

192

{

193

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

194

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

195

},

196

],

197

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

198

},

199

],

200

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

205

<code class="details" id="createSnapshot">createSnapshot(project, region, disk, body=None, guestFlush=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

206

<pre>Creates a snapshot of this regional disk.

207

208

Args:

209

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

210

region: string, Name of the region for this request. (required)

211

disk: string, Name of the regional persistent disk to snapshot. (required)

Dan O'Meara

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

[diff] [blame]

212

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

213

The object takes the form of:

214

215

{ # Represents a Persistent Disk Snapshot resource.

216

#

Dan O'Meara

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

[diff] [blame]

217

# You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)

Bu Sun Kim

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

[diff] [blame]

218

"autoCreated": True or False, # [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

Bu Sun Kim

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

[diff] [blame^]

219

"chainName": "A String", # Chain name should conform to RFC1035.

Bu Sun Kim

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

[diff] [blame]

220

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

221

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

222

"diskSizeGb": "A String", # [Output Only] Size of the source disk, specified in GB.

223

"downloadBytes": "A String", # [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

224

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

Bu Sun Kim

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

[diff] [blame]

225

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

226

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

Bu Sun Kim

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

[diff] [blame]

227

},

228

],

Bu Sun Kim

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

[diff] [blame]

229

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

230

"kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

231

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set 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.

Bu Sun Kim

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

[diff] [blame]

232

#

233

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

Bu Sun Kim

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

[diff] [blame]

234

"labels": { # Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

235

"a_key": "A String",

236

},

237

"licenseCodes": [ # [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

238

"A String",

239

],

240

"licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).

241

"A String",

242

],

243

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

244

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

245

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

246

"snapshotEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the snapshot using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

247

#

248

# After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.

249

#

250

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

251

#

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

255

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

256

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

257

#

258

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

259

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

260

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

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

},

Bu Sun Kim

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

[diff] [blame]

264

"sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.

265

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

266

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

267

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

268

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

269

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

270

#

271

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

272

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

273

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

274

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

275

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

276

},

277

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

278

"status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

279

"storageBytes": "A String", # [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.

280

"storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.

281

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

282

"A String",

283

],

Bu Sun Kim

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

[diff] [blame]

284

}

285

286

guestFlush: boolean, [Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

287

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.

288

289

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.

290

291

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

292

293

Returns:

294

An object of the form:

295

296

{ # Represents an Operation resource.

297

#

Dan O'Meara

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

[diff] [blame]

298

# Google Compute Engine has three Operation resources:

299

#

300

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

301

#

Bu Sun Kim

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

[diff] [blame]

302

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

303

#

304

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

305

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

306

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

307

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

Bu Sun Kim

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

[diff] [blame]

308

#

Dan O'Meara

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

[diff] [blame]

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

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

313

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

314

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

315

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

Sai Cheemalapati

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

[diff] [blame]

316

{

Bu Sun Kim

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

[diff] [blame]

317

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

318

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

319

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

Sai Cheemalapati

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

[diff] [blame]

320

},

321

],

322

},

Bu Sun Kim

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

[diff] [blame]

323

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

324

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

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

{

342

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

343

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

344

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

345

{

346

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

347

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

348

},

349

],

350

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

351

},

352

],

353

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

358

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

Sai Cheemalapati

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

[diff] [blame]

359

<pre>Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

360

361

Args:

362

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

363

region: string, Name of the region for this request. (required)

364

disk: string, Name of the regional persistent disk to delete. (required)

Bu Sun Kim

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

[diff] [blame]

365

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.

366

367

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.

368

369

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]

370

371

Returns:

372

An object of the form:

373

Bu Sun Kim

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

[diff] [blame]

374

{ # Represents an Operation resource.

375

#

Dan O'Meara

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

[diff] [blame]

376

# Google Compute Engine has three Operation resources:

377

#

378

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

379

#

Bu Sun Kim

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

[diff] [blame]

380

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

381

#

382

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

383

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

384

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

385

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

Bu Sun Kim

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

[diff] [blame]

386

#

Dan O'Meara

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

[diff] [blame]

387

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

Bu Sun Kim

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

[diff] [blame]

388

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

389

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

390

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

391

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

392

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

393

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

Sai Cheemalapati

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

[diff] [blame]

394

{

Bu Sun Kim

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

[diff] [blame]

395

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

396

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

397

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

Sai Cheemalapati

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

[diff] [blame]

398

},

399

],

400

},

Bu Sun Kim

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

[diff] [blame]

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

{

420

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

421

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

422

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

423

{

424

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

425

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

426

},

427

],

428

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

429

},

430

],

431

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

437

<pre>Returns a specified regional persistent disk.

438

439

Args:

440

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

441

region: string, Name of the region for this request. (required)

442

disk: string, Name of the regional persistent disk to return. (required)

443

444

Returns:

445

An object of the form:

446

Bu Sun Kim

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

[diff] [blame]

447

{ # Represents a Persistent Disk resource.

Bu Sun Kim

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

[diff] [blame]

448

#

449

# Google Compute Engine has two Disk resources:

450

#

451

# * [Zonal](/compute/docs/reference/rest/{$api_version}/disks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionDisks)

452

#

453

# Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options.

454

#

455

# The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks.

456

#

457

# The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==)

458

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

459

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

460

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

461

#

Bu Sun Kim

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

[diff] [blame]

462

# After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine).

Dan O'Meara

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

[diff] [blame]

463

#

Bu Sun Kim

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

[diff] [blame]

464

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

Dan O'Meara

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

[diff] [blame]

465

#

Bu Sun Kim

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

[diff] [blame]

466

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

467

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

468

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

469

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

470

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

471

#

472

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

473

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

474

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

475

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

476

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

477

},

478

"eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.

479

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

480

{ # Guest OS features.

481

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

Sai Cheemalapati

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

[diff] [blame]

482

},

Bu Sun Kim

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

[diff] [blame]

483

],

484

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

Bu Sun Kim

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

[diff] [blame^]

485

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

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

[diff] [blame]

486

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

487

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set 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.

488

#

489

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

490

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

491

"a_key": "A String",

492

},

493

"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.

494

"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.

495

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

496

"A String",

497

],

498

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

499

"A String",

500

],

501

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

502

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

503

"options": "A String", # Internal use only.

Bu Sun Kim

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

[diff] [blame^]

504

"physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

Bu Sun Kim

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

[diff] [blame]

505

"region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

506

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

507

"A String",

508

],

509

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.

510

"A String",

511

],

512

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

513

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

514

"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.

515

#

516

# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.

517

"sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

518

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

519

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

520

# - zones/zone/disks/disk

521

"sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

522

"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.

523

#

524

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

525

# projects/debian-cloud/global/images/family/debian-9

526

#

527

#

528

# Alternatively, use a specific version of a public operating system image:

529

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

530

#

531

#

532

# To create a disk with a custom image that you created, specify the image name in the following format:

533

# global/images/my-custom-image

534

#

535

#

536

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

537

# global/images/family/my-image-family

538

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

539

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

540

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

541

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

542

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

Sai Cheemalapati

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

[diff] [blame]

543

#

Bu Sun Kim

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

[diff] [blame]

544

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

545

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

546

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

547

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

548

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

549

},

550

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

551

"sourceInPlaceSnapshot": "A String", # The source in-place snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

552

# - https://www.googleapis.com/compute/v1/projects/project/global/inPlaceSnapshots/inPlaceSnapshots

553

# - projects/project/global/inPlaceSnapshots/inPlaceSnapshots

554

# - global/inPlaceSnapshots/inPlaceSnapshots

555

"sourceInPlaceSnapshotId": "A String", # [Output Only] The unique ID of the in-place snapshot used to create this disk. This value identifies the exact in-place snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an in-place snapshot that was later deleted and recreated under the same name, the source in-place snapshot ID would identify the exact version of the in-place snapshot that was used.

556

"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

557

# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot

558

# - projects/project/global/snapshots/snapshot

559

# - global/snapshots/snapshot

560

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

561

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

562

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

563

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

564

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

Sai Cheemalapati

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

[diff] [blame]

565

#

Bu Sun Kim

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

[diff] [blame]

566

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

567

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

568

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

569

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

570

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

571

},

572

"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

573

"sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/.

574

"status": "A String", # [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.

575

"storageType": "A String", # [Deprecated] Storage type of the persistent disk.

Bu Sun Kim

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

[diff] [blame^]

576

"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd

Bu Sun Kim

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

[diff] [blame]

577

"users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

578

"A String",

579

],

580

"zone": "A String", # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

581

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

585

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

Bu Sun Kim

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

[diff] [blame]

586

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

587

588

Args:

589

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

590

region: string, The name of the region for this request. (required)

591

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

Dan O'Meara

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

[diff] [blame]

592

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

593

594

Returns:

595

An object of the form:

596

Dan O'Meara

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

[diff] [blame]

597

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

Bu Sun Kim

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

[diff] [blame]

598

#

599

#

600

#

Dan O'Meara

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

[diff] [blame]

601

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

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

[diff] [blame]

602

#

Bu Sun Kim

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

[diff] [blame]

603

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

604

#

Dan O'Meara

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

[diff] [blame]

605

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

606

#

Bu Sun Kim

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

[diff] [blame]

607

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

608

#

Dan O'Meara

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

[diff] [blame]

609

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

610

#

Bu Sun Kim

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

[diff] [blame]

611

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

612

#

Dan O'Meara

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

[diff] [blame]

613

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

614

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

Bu Sun Kim

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

[diff] [blame]

615

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

616

#

617

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

618

#

619

# Example Policy with multiple AuditConfigs:

620

#

Bu Sun Kim

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

[diff] [blame^]

621

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

Bu Sun Kim

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

[diff] [blame]

622

#

Dan O'Meara

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

[diff] [blame]

623

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

624

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

Bu Sun Kim

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

[diff] [blame]

625

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

626

#

Bu Sun Kim

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

[diff] [blame^]

627

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

Bu Sun Kim

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

[diff] [blame]

628

#

Bu Sun Kim

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

[diff] [blame]

629

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

630

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

631

"A String",

Bu Sun Kim

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

[diff] [blame]

632

],

Bu Sun Kim

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

[diff] [blame]

633

"ignoreChildExemptions": True or False,

634

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

Bu Sun Kim

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

[diff] [blame]

635

},

636

],

Bu Sun Kim

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

[diff] [blame]

"exemptedMembers": [

"A String",

],

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

Bu Sun Kim

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

[diff] [blame]

641

},

642

],

Bu Sun Kim

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

[diff] [blame]

643

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

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

[diff] [blame]

644

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

Bu Sun Kim

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

[diff] [blame]

645

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

646

#

647

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

648

#

649

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

650

#

651

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

652

#

653

# Example (Comparison):

654

#

655

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

656

#

657

# Example (Equality):

658

#

659

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

664

#

665

# Example (Data Manipulation):

666

#

667

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

668

#

669

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

670

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

671

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

672

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

673

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

674

},

675

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

Bu Sun Kim

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

[diff] [blame]

676

#

677

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

678

#

679

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

680

#

Dan O'Meara

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

[diff] [blame]

681

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

Bu Sun Kim

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

[diff] [blame]

#

#

#

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

686

#

687

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

688

#

Dan O'Meara

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

[diff] [blame]

689

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

690

#

691

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

692

#

693

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

694

#

Bu Sun Kim

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

[diff] [blame]

695

#

696

#

697

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

698

"A String",

Bu Sun Kim

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

[diff] [blame]

699

],

Bu Sun Kim

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

[diff] [blame]

700

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

Bu Sun Kim

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

[diff] [blame]

701

},

702

],

Bu Sun Kim

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

[diff] [blame]

703

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

704

#

705

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

706

"iamOwned": True or False,

707

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

708

{ # A rule to be applied in a Policy.

709

"action": "A String", # Required

710

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

711

{ # A condition to be met.

712

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

713

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

714

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

715

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

716

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

"A String",

],

},

],

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

722

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

723

"A String",

724

],

725

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

726

{ # Specifies what kind of log the caller must write

727

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

728

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

729

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

730

},

731

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

732

},

733

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

734

#

735

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

736

#

737

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

738

#

739

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

740

#

741

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

742

"customFields": [ # Custom fields.

743

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

744

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

745

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

746

},

747

],

748

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

749

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

750

},

751

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

752

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

757

"A String",

758

],

759

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

765

#

766

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

767

#

768

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

769

#

770

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

771

#

772

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

773

#

774

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

775

#

776

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

781

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

Sai Cheemalapati

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

[diff] [blame]

782

<pre>Creates a persistent regional disk in the specified project using the data included in the request.

783

784

Args:

785

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

786

region: string, Name of the region for this request. (required)

Dan O'Meara

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

[diff] [blame]

787

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

788

The object takes the form of:

789

Bu Sun Kim

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

[diff] [blame]

790

{ # Represents a Persistent Disk resource.

Bu Sun Kim

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

[diff] [blame]

791

#

792

# Google Compute Engine has two Disk resources:

793

#

794

# * [Zonal](/compute/docs/reference/rest/{$api_version}/disks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionDisks)

795

#

796

# Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options.

797

#

798

# The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks.

799

#

800

# The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==)

801

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

802

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

803

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

804

#

Bu Sun Kim

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

[diff] [blame]

805

# After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine).

Dan O'Meara

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

[diff] [blame]

806

#

Bu Sun Kim

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

[diff] [blame]

807

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

Dan O'Meara

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

[diff] [blame]

808

#

Bu Sun Kim

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

[diff] [blame]

809

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

810

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

811

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

812

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

813

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

814

#

815

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

816

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

817

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

818

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

819

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

820

},

821

"eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.

822

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

823

{ # Guest OS features.

824

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

Sai Cheemalapati

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

[diff] [blame]

825

},

Bu Sun Kim

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

[diff] [blame]

826

],

827

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

Bu Sun Kim

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

[diff] [blame^]

828

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

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

[diff] [blame]

829

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

830

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set 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.

831

#

832

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

833

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

834

"a_key": "A String",

835

},

836

"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.

837

"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.

838

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

839

"A String",

840

],

841

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

842

"A String",

843

],

844

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

845

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

846

"options": "A String", # Internal use only.

Bu Sun Kim

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

[diff] [blame^]

847

"physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

Bu Sun Kim

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

[diff] [blame]

848

"region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

849

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

850

"A String",

851

],

852

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.

853

"A String",

854

],

855

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

856

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

857

"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.

858

#

859

# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.

860

"sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

861

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

862

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

863

# - zones/zone/disks/disk

864

"sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

865

"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.

866

#

867

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

868

# projects/debian-cloud/global/images/family/debian-9

869

#

870

#

871

# Alternatively, use a specific version of a public operating system image:

872

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

873

#

874

#

875

# To create a disk with a custom image that you created, specify the image name in the following format:

876

# global/images/my-custom-image

877

#

878

#

879

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

880

# global/images/family/my-image-family

881

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

882

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

883

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

884

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

885

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

886

#

887

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

888

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

889

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

890

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

891

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

892

},

893

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

894

"sourceInPlaceSnapshot": "A String", # The source in-place snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

895

# - https://www.googleapis.com/compute/v1/projects/project/global/inPlaceSnapshots/inPlaceSnapshots

896

# - projects/project/global/inPlaceSnapshots/inPlaceSnapshots

897

# - global/inPlaceSnapshots/inPlaceSnapshots

898

"sourceInPlaceSnapshotId": "A String", # [Output Only] The unique ID of the in-place snapshot used to create this disk. This value identifies the exact in-place snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an in-place snapshot that was later deleted and recreated under the same name, the source in-place snapshot ID would identify the exact version of the in-place snapshot that was used.

899

"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

900

# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot

901

# - projects/project/global/snapshots/snapshot

902

# - global/snapshots/snapshot

903

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

904

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

905

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

906

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

907

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

908

#

909

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

910

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

911

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

912

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

913

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

914

},

915

"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

916

"sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/.

917

"status": "A String", # [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.

918

"storageType": "A String", # [Deprecated] Storage type of the persistent disk.

Bu Sun Kim

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

[diff] [blame^]

919

"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd

Bu Sun Kim

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

[diff] [blame]

920

"users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

921

"A String",

922

],

923

"zone": "A String", # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

924

}

Sai Cheemalapati

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

[diff] [blame]

925

Bu Sun Kim

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

[diff] [blame]

926

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.

927

928

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.

929

930

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]

931

sourceImage: string, Optional. Source image to restore onto a disk.

932

933

Returns:

934

An object of the form:

935

Bu Sun Kim

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

[diff] [blame]

936

{ # Represents an Operation resource.

937

#

Dan O'Meara

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

[diff] [blame]

938

# Google Compute Engine has three Operation resources:

939

#

940

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

941

#

Bu Sun Kim

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

[diff] [blame]

942

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

943

#

944

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

945

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

946

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

947

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

Bu Sun Kim

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

[diff] [blame]

948

#

Dan O'Meara

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

[diff] [blame]

949

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

Bu Sun Kim

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

[diff] [blame]

950

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

951

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

952

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

953

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

954

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

955

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

Sai Cheemalapati

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

[diff] [blame]

956

{

Bu Sun Kim

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

[diff] [blame]

957

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

958

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

959

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

Sai Cheemalapati

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

[diff] [blame]

960

},

961

],

962

},

Bu Sun Kim

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

[diff] [blame]

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

979

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

980

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

981

{

982

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

983

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

984

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

985

{

986

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

987

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

988

},

989

],

990

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

991

},

992

],

993

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

998

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

Sai Cheemalapati

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

[diff] [blame]

999

<pre>Retrieves the list of persistent disks contained within the specified region.

1000

1001

Args:

1002

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

1003

region: string, Name of the region for this request. (required)

Dan O'Meara

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

[diff] [blame]

1004

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]

1005

Dan O'Meara

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

[diff] [blame]

1006

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]

1007

Dan O'Meara

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

[diff] [blame]

1008

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]

1009

Bu Sun Kim

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

[diff] [blame]

1010

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

1011

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

1012

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

1013

1014

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.

1015

1016

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

1017

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.

1018

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

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

[diff] [blame]

1019

1020

Returns:

1021

An object of the form:

1022

Jon Wayne Parrott

692617a

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

[diff] [blame]

1023

{ # A list of Disk resources.

Bu Sun Kim

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

[diff] [blame]

1024

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

1025

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

Bu Sun Kim

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

[diff] [blame]

1026

{ # Represents a Persistent Disk resource.

Bu Sun Kim

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

[diff] [blame]

1027

#

1028

# Google Compute Engine has two Disk resources:

1029

#

1030

# * [Zonal](/compute/docs/reference/rest/{$api_version}/disks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionDisks)

1031

#

1032

# Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options.

1033

#

1034

# The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks.

1035

#

1036

# The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==)

1037

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

1038

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

1039

"diskEncryptionKey": { # Represents a customer-supplied encryption key # Encrypts the disk using a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

1040

#

Bu Sun Kim

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

[diff] [blame]

1041

# After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine).

Dan O'Meara

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

[diff] [blame]

1042

#

Bu Sun Kim

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

[diff] [blame]

1043

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

Dan O'Meara

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

[diff] [blame]

1044

#

Bu Sun Kim

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

[diff] [blame]

1045

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

1046

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

1047

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

1048

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

1049

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

Sai Cheemalapati

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

[diff] [blame]

1050

#

Bu Sun Kim

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

[diff] [blame]

1051

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

1052

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

1053

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

1054

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

1055

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

Sai Cheemalapati

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

[diff] [blame]

1056

},

Bu Sun Kim

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

[diff] [blame]

1057

"eraseWindowsVssSignature": True or False, # Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.

1058

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

1059

{ # Guest OS features.

1060

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

1061

},

1062

],

1063

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

Bu Sun Kim

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

[diff] [blame^]

1064

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

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

[diff] [blame]

1065

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

1066

"labelFingerprint": "A String", # A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set 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.

1067

#

1068

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

1069

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

1070

"a_key": "A String",

1071

},

1072

"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.

1073

"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.

1074

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

1075

"A String",

1076

],

1077

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

1078

"A String",

1079

],

1080

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1081

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

1082

"options": "A String", # Internal use only.

Bu Sun Kim

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

[diff] [blame^]

1083

"physicalBlockSizeBytes": "A String", # Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

Bu Sun Kim

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

[diff] [blame]

1084

"region": "A String", # [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1085

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1086

"A String",

1087

],

1088

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.

1089

"A String",

1090

],

1091

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

1092

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

1093

"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.

1094

#

1095

# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.

1096

"sourceDisk": "A String", # The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

1097

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

1098

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

1099

# - zones/zone/disks/disk

1100

"sourceDiskId": "A String", # [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

1101

"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted, this field will not be set.

1102

#

1103

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

1104

# projects/debian-cloud/global/images/family/debian-9

1105

#

1106

#

1107

# Alternatively, use a specific version of a public operating system image:

1108

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1109

#

1110

#

1111

# To create a disk with a custom image that you created, specify the image name in the following format:

1112

# global/images/my-custom-image

1113

#

1114

#

1115

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

1116

# global/images/family/my-image-family

1117

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

1118

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

1119

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

1120

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

1121

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

1122

#

1123

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

1124

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

1125

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

1126

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

1127

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

1128

},

1129

"sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

1130

"sourceInPlaceSnapshot": "A String", # The source in-place snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

1131

# - https://www.googleapis.com/compute/v1/projects/project/global/inPlaceSnapshots/inPlaceSnapshots

1132

# - projects/project/global/inPlaceSnapshots/inPlaceSnapshots

1133

# - global/inPlaceSnapshots/inPlaceSnapshots

1134

"sourceInPlaceSnapshotId": "A String", # [Output Only] The unique ID of the in-place snapshot used to create this disk. This value identifies the exact in-place snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an in-place snapshot that was later deleted and recreated under the same name, the source in-place snapshot ID would identify the exact version of the in-place snapshot that was used.

1135

"sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

1136

# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot

1137

# - projects/project/global/snapshots/snapshot

1138

# - global/snapshots/snapshot

1139

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

1140

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

1141

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

1142

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

1143

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

1144

#

1145

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

1146

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

1147

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

1148

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

1149

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

1150

},

1151

"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

1152

"sourceStorageObject": "A String", # The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/.

1153

"status": "A String", # [Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.

1154

"storageType": "A String", # [Deprecated] Storage type of the persistent disk.

Bu Sun Kim

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

[diff] [blame^]

1155

"type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd

Bu Sun Kim

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

[diff] [blame]

1156

"users": [ # [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

1157

"A String",

1158

],

1159

"zone": "A String", # [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1160

},

Sai Cheemalapati

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

[diff] [blame]

1161

],

Bu Sun Kim

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

[diff] [blame]

1162

"kind": "compute#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.

1163

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

1164

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

1165

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

1166

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

1167

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

1168

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

Bu Sun Kim

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

[diff] [blame]

1169

{

Bu Sun Kim

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

[diff] [blame]

1170

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

1171

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

Bu Sun Kim

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

[diff] [blame]

1172

},

1173

],

Bu Sun Kim

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

[diff] [blame]

1174

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

Bu Sun Kim

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

[diff] [blame]

1175

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

1181

<pre>Retrieves the next page of results.

1182

1183

Args:

1184

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

1185

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

1186

1187

Returns:

Bu Sun Kim

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

[diff] [blame]

1188

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

Sai Cheemalapati

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

[diff] [blame]

1189

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]

1194

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, region, disk, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

1195

<pre>Removes resource policies from a regional disk.

Sai Cheemalapati

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

[diff] [blame]

1196

1197

Args:

Bu Sun Kim

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

[diff] [blame]

1198

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

1199

region: string, The name of the region for this request. (required)

1200

disk: string, The disk name for this request. (required)

Dan O'Meara

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

[diff] [blame]

1201

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1202

The object takes the form of:

1203

1204

{

Bu Sun Kim

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

[diff] [blame]

1205

"resourcePolicies": [ # Resource policies to be removed from this disk.

1206

"A String",

Bu Sun Kim

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

[diff] [blame]

1207

],

Sai Cheemalapati

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

[diff] [blame]

1208

}

1209

Bu Sun Kim

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

[diff] [blame]

1210

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.

1211

1212

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.

1213

1214

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]

1215

1216

Returns:

1217

An object of the form:

1218

Bu Sun Kim

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

[diff] [blame]

1219

{ # Represents an Operation resource.

1220

#

Dan O'Meara

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

[diff] [blame]

1221

# Google Compute Engine has three Operation resources:

1222

#

1223

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

1224

#

Bu Sun Kim

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

[diff] [blame]

1225

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

1226

#

1227

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1228

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

1229

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

1230

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

Bu Sun Kim

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

[diff] [blame]

1231

#

Dan O'Meara

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

[diff] [blame]

1232

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

Bu Sun Kim

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

[diff] [blame]

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

Sai Cheemalapati

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

[diff] [blame]

1239

{

Bu Sun Kim

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

[diff] [blame]

1240

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

1241

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

1242

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

Sai Cheemalapati

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

[diff] [blame]

1243

},

1244

],

1245

},

Bu Sun Kim

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

[diff] [blame]

1246

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

1247

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

1248

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

1249

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

1250

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

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

{

1265

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

1266

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

1267

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

1268

{

1269

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

1270

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

1271

},

1272

],

1273

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

1274

},

1275

],

1276

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1281

<code class="details" id="resize">resize(project, region, disk, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

1282

<pre>Resizes the specified regional persistent disk.

Sai Cheemalapati

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

[diff] [blame]

1283

1284

Args:

Bu Sun Kim

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

[diff] [blame]

1285

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

1286

region: string, Name of the region for this request. (required)

1287

disk: string, Name of the regional persistent disk. (required)

Dan O'Meara

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

[diff] [blame]

1288

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1289

The object takes the form of:

1290

1291

{

Bu Sun Kim

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

[diff] [blame]

1292

"sizeGb": "A String", # The new size of the regional persistent disk, which is specified in GB.

Sai Cheemalapati

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

[diff] [blame]

1293

}

1294

Bu Sun Kim

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

[diff] [blame]

1295

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.

1296

1297

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.

1298

1299

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]

1300

1301

Returns:

1302

An object of the form:

1303

Bu Sun Kim

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

[diff] [blame]

1304

{ # Represents an Operation resource.

1305

#

Dan O'Meara

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

[diff] [blame]

1306

# Google Compute Engine has three Operation resources:

1307

#

1308

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

1309

#

Bu Sun Kim

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

[diff] [blame]

1310

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

1311

#

1312

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1313

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

1314

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

1315

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

Bu Sun Kim

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

[diff] [blame]

1316

#

Dan O'Meara

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

[diff] [blame]

1317

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

Bu Sun Kim

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

[diff] [blame]

1318

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

1319

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

1320

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

1321

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

1322

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

1323

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

Bu Sun Kim

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

[diff] [blame]

1324

{

Bu Sun Kim

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

[diff] [blame]

1325

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

1326

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

1327

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

Bu Sun Kim

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

[diff] [blame]

1328

},

1329

],

1330

},

Bu Sun Kim

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

[diff] [blame]

1331

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

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

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

1349

{

1350

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

1351

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

1352

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

1353

{

1354

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

1355

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

1356

},

1357

],

1358

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

1359

},

1360

],

1361

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1366

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

Bu Sun Kim

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

[diff] [blame]

1367

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

1368

1369

Args:

1370

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

1371

region: string, The name of the region for this request. (required)

1372

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

Dan O'Meara

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

[diff] [blame]

1373

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1374

The object takes the form of:

1375

1376

{

Bu Sun Kim

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

[diff] [blame]

1377

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

1378

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

1379

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

1380

#

1381

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

1382

#

1383

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

1384

#

1385

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1386

#

1387

# Example (Comparison):

1388

#

1389

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1390

#

1391

# Example (Equality):

1392

#

1393

# 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'"

1398

#

1399

# Example (Data Manipulation):

1400

#

1401

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1402

#

1403

# 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.

1404

"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.

1405

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1406

"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.

1407

"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.

1408

},

1409

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1410

#

1411

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1412

#

1413

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1414

#

1415

# * `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`.

1420

#

1421

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1422

#

1423

# * `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.

1424

#

1425

# * `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.

1426

#

1427

# * `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`.

1432

"A String",

1433

],

1434

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1435

},

1436

],

1437

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1438

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1439

#

1440

#

1441

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1442

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1443

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1444

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1445

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1446

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1447

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1448

# { "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]

1449

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1450

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1451

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1452

# 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]

1453

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1454

# 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]

1455

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1456

{ # 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.

1457

#

1458

# 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.

1459

#

1460

# Example Policy with multiple AuditConfigs:

1461

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1462

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1463

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1464

# 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]

1465

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1466

{ # Provides the configuration for logging a type of permissions. Example:

1467

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1468

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1469

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1470

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1471

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1472

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1473

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1474

"ignoreChildExemptions": True or False,

1475

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1476

},

1477

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1482

},

1483

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1485

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1486

"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.

1487

#

1488

# If the condition evaluates to `true`, then this binding applies to the current request.

1489

#

1490

# 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.

1491

#

1492

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1493

#

1494

# Example (Comparison):

1495

#

1496

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1497

#

1498

# Example (Equality):

1499

#

1500

# 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'"

1505

#

1506

# Example (Data Manipulation):

1507

#

1508

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1509

#

1510

# 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.

1511

"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.

1512

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1513

"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.

1514

"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.

1515

},

1516

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1517

#

1518

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1519

#

1520

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1521

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1522

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1527

#

1528

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1529

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1530

# * `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.

1531

#

1532

# * `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.

1533

#

1534

# * `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.

1535

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1536

#

1537

#

1538

# * `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]

1539

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1540

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1541

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1542

},

1543

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1544

"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.

1545

#

1546

# **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.

1547

"iamOwned": True or False,

1548

"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.

1549

{ # A rule to be applied in a Policy.

1550

"action": "A String", # Required

1551

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1552

{ # A condition to be met.

1553

"iam": "A String", # Trusted attributes supplied by the IAM system.

1554

"op": "A String", # An operator to apply the subject with.

1555

"svc": "A String", # Trusted attributes discharged by the service.

1556

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1557

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1563

"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.

1564

"A String",

1565

],

1566

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1567

{ # Specifies what kind of log the caller must write

1568

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1569

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1570

"permissionType": "A String", # The type of the permission that was checked.

1571

},

1572

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1573

},

1574

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1575

#

1576

# 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.

1577

#

1578

# Field names correspond to IAM request parameters and field values are their respective values.

1579

#

1580

# 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.

1581

#

1582

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1583

"customFields": [ # Custom fields.

1584

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1585

"name": "A String", # Name is the field name.

1586

"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.

1587

},

1588

],

1589

"field": "A String", # The field value to attribute.

1590

"metric": "A String", # The metric to update.

1591

},

1592

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1593

"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.

1598

"A String",

1599

],

1600

"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.

1601

"A String",

1602

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1603

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1604

],

1605

"version": 42, # Specifies the format of the policy.

1606

#

1607

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1608

#

1609

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1610

#

1611

# * 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

1612

#

1613

# **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.

1614

#

1615

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1616

#

1617

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1618

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

1624

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1625

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1626

#

1627

#

1628

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1629

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1630

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1631

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1632

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1633

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1634

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1635

# { "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]

1636

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1637

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1638

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1639

# 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]

1640

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1641

# 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]

1642

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1643

{ # 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.

1644

#

1645

# 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.

1646

#

1647

# Example Policy with multiple AuditConfigs:

1648

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1649

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1650

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1651

# 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]

1652

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1653

{ # Provides the configuration for logging a type of permissions. Example:

1654

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1655

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1656

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1657

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1658

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1659

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1660

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1661

"ignoreChildExemptions": True or False,

1662

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1663

},

1664

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1669

},

1670

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1671

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1672

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1673

"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.

1674

#

1675

# If the condition evaluates to `true`, then this binding applies to the current request.

1676

#

1677

# 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.

1678

#

1679

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1680

#

1681

# Example (Comparison):

1682

#

1683

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1684

#

1685

# Example (Equality):

1686

#

1687

# 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'"

1692

#

1693

# Example (Data Manipulation):

1694

#

1695

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1696

#

1697

# 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.

1698

"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.

1699

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1700

"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.

1701

"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.

1702

},

1703

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1704

#

1705

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1706

#

1707

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1708

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1709

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1714

#

1715

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1716

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1717

# * `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.

1718

#

1719

# * `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.

1720

#

1721

# * `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.

1722

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1723

#

1724

#

1725

# * `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]

1726

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1727

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1728

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1729

},

1730

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1731

"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.

1732

#

1733

# **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.

1734

"iamOwned": True or False,

1735

"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.

1736

{ # A rule to be applied in a Policy.

1737

"action": "A String", # Required

1738

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1739

{ # A condition to be met.

1740

"iam": "A String", # Trusted attributes supplied by the IAM system.

1741

"op": "A String", # An operator to apply the subject with.

1742

"svc": "A String", # Trusted attributes discharged by the service.

1743

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1744

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1750

"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.

1751

"A String",

1752

],

1753

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1754

{ # Specifies what kind of log the caller must write

1755

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1756

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1757

"permissionType": "A String", # The type of the permission that was checked.

1758

},

1759

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1760

},

1761

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1762

#

1763

# 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.

1764

#

1765

# Field names correspond to IAM request parameters and field values are their respective values.

1766

#

1767

# 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.

1768

#

1769

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1770

"customFields": [ # Custom fields.

1771

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1772

"name": "A String", # Name is the field name.

1773

"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.

1774

},

1775

],

1776

"field": "A String", # The field value to attribute.

1777

"metric": "A String", # The metric to update.

1778

},

1779

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1780

"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.

1785

"A String",

1786

],

1787

"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.

1793

#

1794

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1795

#

1796

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1797

#

1798

# * 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

1799

#

1800

# **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.

1801

#

1802

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1803

#

1804

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1809

<code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1810

<pre>Sets the labels on the target regional disk.

1811

1812

Args:

1813

project: string, Project ID for this request. (required)

1814

region: string, The region for this request. (required)

1815

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1816

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1817

The object takes the form of:

1818

1819

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1820

"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 in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.

1821

"labels": { # The labels to set for this resource.

1822

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

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.

1827

1828

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.

1829

1830

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1831

1832

Returns:

1833

An object of the form:

1834

1835

{ # Represents an Operation resource.

1836

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1837

# Google Compute Engine has three Operation resources:

1838

#

1839

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1840

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1841

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1842

#

1843

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1844

# - For global operations, use the `globalOperations` resource.

1845

# - For regional operations, use the `regionOperations` resource.

1846

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1847

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1848

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1849

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1850

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1851

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1852

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1853

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1854

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1855

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1856

"code": "A String", # [Output Only] The error type identifier for this error.

1857

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1858

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1859

},

1860

],

1861

},

Bu Sun Kim