Blame - docs/dyn/deploymentmanager_v2.deployments.html - platform/external/python/google-api-python-client

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

[diff] [blame]

78

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

Takashi Matsuo

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

[diff] [blame]

79

<p class="firstline">Cancels and removes the preview currently associated with the deployment.</p>

80

Dmitry Frenkel

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

[diff] [blame]

81

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

82

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

83

Jon Wayne Parrott

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

[diff] [blame]

84

<code><a href="#delete">delete(project, deployment, deletePolicy=None)</a></code></p>

Takashi Matsuo

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

[diff] [blame]

85

<p class="firstline">Deletes a deployment and all of the resources in the deployment.</p>

86

87

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

88

<p class="firstline">Gets information about a specific deployment.</p>

89

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

90

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

91

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

92

Dmitry Frenkel

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

[diff] [blame]

93

<code><a href="#insert">insert(project, body=None, preview=None, createPolicy=None)</a></code></p>

Takashi Matsuo

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

[diff] [blame]

94

<p class="firstline">Creates a deployment and all of the resources described by the deployment manifest.</p>

95

Dmitry Frenkel

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

[diff] [blame]

96

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

Takashi Matsuo

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

[diff] [blame]

97

<p class="firstline">Lists all deployments for a given project.</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

Dmitry Frenkel

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

[diff] [blame]

102

<code><a href="#patch">patch(project, deployment, body=None, deletePolicy=None, preview=None, createPolicy=None)</a></code></p>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

103

<p class="firstline">Patches a deployment and all of the resources described by the deployment manifest.</p>

Takashi Matsuo

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

[diff] [blame]

104

Dan O'Meara

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

[diff] [blame]

105

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Takashi Matsuo

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

[diff] [blame]

109

<p class="firstline">Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.</p>

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

112

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

113

Dmitry Frenkel

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

[diff] [blame]

114

<code><a href="#update">update(project, deployment, body=None, deletePolicy=None, createPolicy=None, preview=None)</a></code></p>

Takashi Matsuo

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

[diff] [blame]

115

<p class="firstline">Updates a deployment and all of the resources described by the deployment manifest.</p>

116

<h3>Method Details</h3>

117

Dan O'Meara

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

[diff] [blame]

118

<code class="details" id="cancelPreview">cancelPreview(project, deployment, body=None)</code>

Takashi Matsuo

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

[diff] [blame]

119

<pre>Cancels and removes the preview currently associated with the deployment.

120

121

Args:

122

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

123

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

Dan O'Meara

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

[diff] [blame]

124

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

125

The object takes the form of:

126

127

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

128

"fingerprint": "A String", # Specifies a fingerprint for `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided in `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to cancel a preview, this would prevent one of the requests).

Takashi Matsuo

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

[diff] [blame]

129

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

130

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.

Takashi Matsuo

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

[diff] [blame]

}

Returns:

An object of the form:

136

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

137

{ # Represents an Operation resource.

138

#

139

# Google Compute Engine has three Operation resources:

140

#

141

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

142

#

143

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

144

#

145

# Operations can be global, regional or zonal.

146

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

147

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

148

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

149

#

150

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

Dmitry Frenkel

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

[diff] [blame]

151

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

Bu Sun Kim

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

[diff] [blame]

152

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

Dmitry Frenkel

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

[diff] [blame]

153

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

154

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

155

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

156

{

157

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

158

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

159

{

160

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

161

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

162

},

163

],

164

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

165

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

166

},

167

],

168

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

169

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

Bu Sun Kim

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

[diff] [blame]

170

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

Dmitry Frenkel

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

[diff] [blame]

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

Takashi Matsuo

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

[diff] [blame]

183

{

Bu Sun Kim

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

[diff] [blame]

184

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

Dmitry Frenkel

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

[diff] [blame]

185

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

Bu Sun Kim

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

[diff] [blame]

186

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

Takashi Matsuo

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

[diff] [blame]

187

},

188

],

189

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

190

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

Dmitry Frenkel

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

[diff] [blame]

191

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

192

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

193

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

Takashi Matsuo

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

198

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

199

<pre>Close httplib2 connections.</pre>

</div>

Jon Wayne Parrott

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

[diff] [blame]

203

<code class="details" id="delete">delete(project, deployment, deletePolicy=None)</code>

Takashi Matsuo

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

[diff] [blame]

204

<pre>Deletes a deployment and all of the resources in the deployment.

205

206

Args:

207

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

208

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

Jon Wayne Parrott

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

[diff] [blame]

209

deletePolicy: string, Sets the policy to use for deleting resources.

210

Allowed values

211

ABANDON -

212

DELETE -

Takashi Matsuo

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

[diff] [blame]

213

214

Returns:

215

An object of the form:

216

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

217

{ # Represents an Operation resource.

218

#

219

# Google Compute Engine has three Operation resources:

220

#

221

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

222

#

223

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

224

#

225

# Operations can be global, regional or zonal.

226

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

227

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

228

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

229

#

230

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

Dmitry Frenkel

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

[diff] [blame]

231

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

Bu Sun Kim

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

[diff] [blame]

232

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

Dmitry Frenkel

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

[diff] [blame]

233

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

234

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

235

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

236

{

237

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

238

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

239

{

240

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

241

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

242

},

243

],

244

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

245

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

246

},

247

],

248

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

249

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

Bu Sun Kim

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

[diff] [blame]

250

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

Dmitry Frenkel

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

[diff] [blame]

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

262

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

Takashi Matsuo

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

[diff] [blame]

263

{

Bu Sun Kim

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

[diff] [blame]

264

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

Dmitry Frenkel

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

[diff] [blame]

265

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

Bu Sun Kim

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

[diff] [blame]

266

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

Takashi Matsuo

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

[diff] [blame]

267

},

268

],

269

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

270

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

Dmitry Frenkel

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

[diff] [blame]

271

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

272

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

273

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

Takashi Matsuo

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

[diff] [blame]

}</pre>

</div>

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

279

<pre>Gets information about a specific deployment.

280

281

Args:

282

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

283

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

284

285

Returns:

286

An object of the form:

287

288

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

289

"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

290

{

291

"key": "A String",

292

"value": "A String",

Takashi Matsuo

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

[diff] [blame]

293

},

Bu Sun Kim

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

[diff] [blame]

294

],

Dmitry Frenkel

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

[diff] [blame]

295

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

296

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

297

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

298

"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.

299

{

300

"name": "A String", # The name of the file.

301

"content": "A String", # The contents of the file.

302

},

303

],

304

"config": { # The configuration to use for this deployment.

305

"content": "A String", # The contents of the file.

306

},

307

},

308

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

309

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

310

#

311

# Google Compute Engine has three Operation resources:

312

#

313

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

314

#

315

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

316

#

317

# Operations can be global, regional or zonal.

318

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

319

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

320

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

321

#

322

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

Dmitry Frenkel

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

[diff] [blame]

323

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

Bu Sun Kim

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

[diff] [blame]

324

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

Dmitry Frenkel

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

[diff] [blame]

325

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

326

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

327

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

328

{

329

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

330

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

331

{

332

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

333

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

334

},

335

],

336

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

337

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

338

},

339

],

340

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

341

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

Bu Sun Kim

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

[diff] [blame]

342

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

Dmitry Frenkel

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

[diff] [blame]

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

Bu Sun Kim

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

[diff] [blame]

353

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

354

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

Takashi Matsuo

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

[diff] [blame]

355

{

Bu Sun Kim

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

[diff] [blame]

356

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

Dmitry Frenkel

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

[diff] [blame]

357

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

Bu Sun Kim

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

[diff] [blame]

358

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

Takashi Matsuo

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

[diff] [blame]

359

},

360

],

Bu Sun Kim

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

[diff] [blame]

361

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

362

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

Dmitry Frenkel

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

[diff] [blame]

363

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

364

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

365

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

Bu Sun Kim

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

[diff] [blame]

366

},

Dmitry Frenkel

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

[diff] [blame]

367

"description": "A String", # An optional user-provided description of the deployment.

368

"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.

369

#

370

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

371

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

Bu Sun Kim

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

[diff] [blame]

372

"selfLink": "A String", # Output only. Server defined URL for the resource.

Dmitry Frenkel

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

[diff] [blame]

373

"manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.

Bu Sun Kim

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

[diff] [blame]

374

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

Dmitry Frenkel

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

[diff] [blame]

375

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

376

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Dmitry Frenkel

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

[diff] [blame]

382

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

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

[diff] [blame]

383

},

Bu Sun Kim

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

[diff] [blame]

384

}</pre>

Takashi Matsuo

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

[diff] [blame]

</div>

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

388

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

389

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

390

391

Args:

392

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

Bu Sun Kim

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

[diff] [blame]

393

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

394

395

Returns:

396

An object of the form:

397

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

398

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

399

#

400

#

401

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

402

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

403

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

404

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

405

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

406

# **JSON example:**

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

407

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

408

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

409

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

410

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

411

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

412

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

413

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

414

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

415

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

Sai Cheemalapati

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

[diff] [blame]

416

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

Sai Cheemalapati

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

[diff] [blame]

417

#

Bu Sun Kim

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

[diff] [blame]

418

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

Sai Cheemalapati

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

[diff] [blame]

419

#

420

# Example Policy with multiple AuditConfigs:

421

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

422

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

Sai Cheemalapati

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

[diff] [blame]

423

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

424

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

Dmitry Frenkel

2020-10-06 16:46:05 -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

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

[diff] [blame]

429

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

Sai Cheemalapati

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

[diff] [blame]

430

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

431

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

432

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

Sai Cheemalapati

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

[diff] [blame]

433

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

434

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

Dmitry Frenkel

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

[diff] [blame]

435

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

436

"ignoreChildExemptions": True or False,

Bu Sun Kim

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

[diff] [blame]

437

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

438

"A String",

Jon Wayne Parrott

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

[diff] [blame]

439

],

Jon Wayne Parrott

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

[diff] [blame]

440

},

441

],

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

442

},

443

],

Dmitry Frenkel

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

[diff] [blame]

444

"iamOwned": True or False,

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

445

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

446

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

Bu Sun Kim

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

[diff] [blame]

447

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

448

#

449

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

450

#

451

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

452

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

453

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

454

#

Jon Wayne Parrott

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

[diff] [blame]

455

#

456

#

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

457

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

458

#

459

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

460

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

461

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

462

#

463

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

464

#

465

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

Bu Sun Kim

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

[diff] [blame]

466

#

467

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

468

#

469

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

470

"A String",

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

471

],

Dmitry Frenkel

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

[diff] [blame]

472

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

473

#

474

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

475

#

476

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

477

#

478

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

479

#

480

# Example (Comparison):

481

#

482

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

483

#

484

# Example (Equality):

485

#

486

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

491

#

492

# Example (Data Manipulation):

493

#

494

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

495

#

496

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

497

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

498

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

499

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

500

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

501

},

Bu Sun Kim

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

[diff] [blame]

502

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

503

},

504

],

Bu Sun Kim

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

[diff] [blame]

505

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

506

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

507

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Bu Sun Kim

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

[diff] [blame]

508

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

509

{ # A rule to be applied in a Policy.

Bu Sun Kim

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

[diff] [blame]

510

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

511

"A String",

512

],

Dmitry Frenkel

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

[diff] [blame]

513

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

514

"A String",

515

],

516

"action": "A String", # Required

517

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

518

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

519

{ # A condition to be met.

520

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

521

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

522

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

523

"A String",

524

],

525

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

526

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

527

},

528

],

Bu Sun Kim

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

[diff] [blame]

529

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

530

{ # Specifies what kind of log the caller must write

Dmitry Frenkel

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

[diff] [blame]

531

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

532

"logMode": "A String",

533

},

Bu Sun Kim

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

[diff] [blame]

534

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

535

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

536

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

537

},

538

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

539

},

540

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

541

#

542

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

543

#

544

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

545

#

546

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

547

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

548

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

Dmitry Frenkel

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

[diff] [blame]

549

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

550

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

551

"customFields": [ # Custom fields.

552

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

553

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

554

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

555

},

556

],

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

561

"A String",

562

],

Bu Sun Kim

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

[diff] [blame]

563

},

564

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

565

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

566

#

567

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

568

#

569

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

570

#

571

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

572

#

573

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

574

#

575

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

576

#

577

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

582

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

Takashi Matsuo

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

[diff] [blame]

583

<pre>Creates a deployment and all of the resources described by the deployment manifest.

584

585

Args:

586

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

Dan O'Meara

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

[diff] [blame]

587

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

588

The object takes the form of:

589

590

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

591

"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

592

{

593

"key": "A String",

594

"value": "A String",

Takashi Matsuo

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

[diff] [blame]

595

},

Bu Sun Kim

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

[diff] [blame]

596

],

Dmitry Frenkel

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

[diff] [blame]

597

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

598

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

599

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

600

"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.

601

{

602

"name": "A String", # The name of the file.

603

"content": "A String", # The contents of the file.

604

},

605

],

606

"config": { # The configuration to use for this deployment.

607

"content": "A String", # The contents of the file.

608

},

609

},

610

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

611

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

612

#

613

# Google Compute Engine has three Operation resources:

614

#

615

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

616

#

617

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

618

#

619

# Operations can be global, regional or zonal.

620

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

621

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

622

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

623

#

624

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

Dmitry Frenkel

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

[diff] [blame]

625

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

Bu Sun Kim

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

[diff] [blame]

626

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

Dmitry Frenkel

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

[diff] [blame]

627

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

628

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

629

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

630

{

631

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

632

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

633

{

634

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

635

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

636

},

637

],

638

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

639

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

640

},

641

],

642

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

643

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

Bu Sun Kim

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

[diff] [blame]

644

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

Dmitry Frenkel

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

[diff] [blame]

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

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

Bu Sun Kim

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

[diff] [blame]

655

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

656

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

Takashi Matsuo

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

[diff] [blame]

657

{

Bu Sun Kim

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

[diff] [blame]

658

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

Dmitry Frenkel

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

[diff] [blame]

659

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

Bu Sun Kim

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

[diff] [blame]

660

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

Takashi Matsuo

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

[diff] [blame]

661

},

662

],

Bu Sun Kim

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

[diff] [blame]

663

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

664

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

Dmitry Frenkel

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

[diff] [blame]

665

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

666

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

667

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

Bu Sun Kim

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

[diff] [blame]

668

},

Dmitry Frenkel

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

[diff] [blame]

669

"description": "A String", # An optional user-provided description of the deployment.

670

"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.

671

#

672

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

673

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

Bu Sun Kim

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

[diff] [blame]

674

"selfLink": "A String", # Output only. Server defined URL for the resource.

Dmitry Frenkel

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

[diff] [blame]

675

"manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.

Bu Sun Kim

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

[diff] [blame]

676

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

Dmitry Frenkel

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

[diff] [blame]

677

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

678

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Dmitry Frenkel

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

[diff] [blame]

684

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

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

[diff] [blame]

685

},

Bu Sun Kim

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

[diff] [blame]

686

}

Takashi Matsuo

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

[diff] [blame]

687

Dmitry Frenkel

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

[diff] [blame]

688

preview: boolean, If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the `update()` method or you can use the `cancelPreview()` method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Bu Sun Kim

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

[diff] [blame]

689

createPolicy: string, Sets the policy to use for creating new resources.

690

Allowed values

691

ACQUIRE -

692

CREATE_OR_ACQUIRE -

Takashi Matsuo

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

[diff] [blame]

693

694

Returns:

695

An object of the form:

696

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

697

{ # Represents an Operation resource.

698

#

699

# Google Compute Engine has three Operation resources:

700

#

701

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

702

#

703

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

704

#

705

# Operations can be global, regional or zonal.

706

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

707

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

708

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

709

#

710

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

Dmitry Frenkel

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

[diff] [blame]

711

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

Bu Sun Kim

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

[diff] [blame]

712

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

Dmitry Frenkel

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

[diff] [blame]

713

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

714

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

715

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

716

{

717

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

718

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

719

{

720

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

721

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

722

},

723

],

724

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

725

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

726

},

727

],

728

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

729

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

Bu Sun Kim

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

[diff] [blame]

730

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

Dmitry Frenkel

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

[diff] [blame]

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

Bu Sun Kim

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

[diff] [blame]

741

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

742

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

Takashi Matsuo

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

[diff] [blame]

743

{

Bu Sun Kim

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

[diff] [blame]

744

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

Dmitry Frenkel

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

[diff] [blame]

745

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

Bu Sun Kim

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

[diff] [blame]

746

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

Takashi Matsuo

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

[diff] [blame]

747

},

748

],

749

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

750

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

Dmitry Frenkel

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

[diff] [blame]

751

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

752

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

753

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

Takashi Matsuo

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

758

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

Takashi Matsuo

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

[diff] [blame]

759

<pre>Lists all deployments for a given project.

760

761

Args:

762

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

Dmitry Frenkel

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

[diff] [blame]

763

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

764

765

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.

766

767

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

768

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

769

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

Takashi Matsuo

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

[diff] [blame]

770

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

771

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

Takashi Matsuo

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

[diff] [blame]

772

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

773

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

Jon Wayne Parrott

36e41bc

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

[diff] [blame]

774

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

775

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

776

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.

Takashi Matsuo

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

[diff] [blame]

777

778

Returns:

779

An object of the form:

780

781

{ # A response containing a partial list of deployments and a page token used to build the next request if the request has been truncated.

Dmitry Frenkel

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

[diff] [blame]

782

"nextPageToken": "A String", # Output only. A token used to continue a truncated list request.

Bu Sun Kim

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

[diff] [blame]

783

"deployments": [ # Output only. The deployments contained in this response.

Takashi Matsuo

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

[diff] [blame]

784

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

785

"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

786

{

787

"key": "A String",

788

"value": "A String",

Takashi Matsuo

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

[diff] [blame]

789

},

Bu Sun Kim

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

[diff] [blame]

790

],

Dmitry Frenkel

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

[diff] [blame]

791

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

792

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

793

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

794

"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.

795

{

796

"name": "A String", # The name of the file.

797

"content": "A String", # The contents of the file.

798

},

799

],

800

"config": { # The configuration to use for this deployment.

801

"content": "A String", # The contents of the file.

802

},

803

},

804

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

805

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

806

#

807

# Google Compute Engine has three Operation resources:

808

#

809

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

810

#

811

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

812

#

813

# Operations can be global, regional or zonal.

814

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

815

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

816

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

817

#

818

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

Dmitry Frenkel

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

[diff] [blame]

819

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

Bu Sun Kim

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

[diff] [blame]

820

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

Dmitry Frenkel

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

[diff] [blame]

821

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

822

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

823

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

824

{

825

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

826

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

827

{

828

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

829

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

830

},

831

],

832

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

833

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

834

},

835

],

836

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

837

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

Bu Sun Kim

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

[diff] [blame]

838

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

Dmitry Frenkel

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

[diff] [blame]

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

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

Bu Sun Kim

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

[diff] [blame]

849

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

850

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

Takashi Matsuo

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

[diff] [blame]

851

{

Bu Sun Kim

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

[diff] [blame]

852

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

Dmitry Frenkel

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

[diff] [blame]

853

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

Bu Sun Kim

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

[diff] [blame]

854

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

Takashi Matsuo

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

[diff] [blame]

855

},

856

],

Bu Sun Kim

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

[diff] [blame]

857

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

858

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

Dmitry Frenkel

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

[diff] [blame]

859

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

860

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

861

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

Takashi Matsuo

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

[diff] [blame]

862

},

Dmitry Frenkel

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

[diff] [blame]

863

"description": "A String", # An optional user-provided description of the deployment.

864

"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.

865

#

866

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

867

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

Bu Sun Kim

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

[diff] [blame]

868

"selfLink": "A String", # Output only. Server defined URL for the resource.

Dmitry Frenkel

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

[diff] [blame]

869

"manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.

Bu Sun Kim

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

[diff] [blame]

870

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

Dmitry Frenkel

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

[diff] [blame]

871

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

872

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Dmitry Frenkel

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

[diff] [blame]

878

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

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

[diff] [blame]

879

},

Bu Sun Kim

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

[diff] [blame]

880

},

Takashi Matsuo

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

[diff] [blame]

],

}</pre>

</div>

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

887

<pre>Retrieves the next page of results.

888

889

Args:

890

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

891

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

892

893

Returns:

Bu Sun Kim

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

[diff] [blame]

894

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

Takashi Matsuo

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

[diff] [blame]

895

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

900

<code class="details" id="patch">patch(project, deployment, body=None, deletePolicy=None, preview=None, createPolicy=None)</code>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

901

<pre>Patches a deployment and all of the resources described by the deployment manifest.

Takashi Matsuo

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

[diff] [blame]

902

903

Args:

904

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

905

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

Dan O'Meara

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

[diff] [blame]

906

body: object, The request body.

Takashi Matsuo

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

[diff] [blame]

907

The object takes the form of:

908

909

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

910

"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

911

{

912

"key": "A String",

913

"value": "A String",

Takashi Matsuo

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

[diff] [blame]

914

},

Bu Sun Kim

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

[diff] [blame]

915

],

Dmitry Frenkel

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

[diff] [blame]

916

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

917

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

918

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

919

"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.

920

{

921

"name": "A String", # The name of the file.

922

"content": "A String", # The contents of the file.

923

},

924

],

925

"config": { # The configuration to use for this deployment.

926

"content": "A String", # The contents of the file.

927

},

928

},

929

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

930

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

931

#

932

# Google Compute Engine has three Operation resources:

933

#

934

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

935

#

936

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

937

#

938

# Operations can be global, regional or zonal.

939

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

940

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

941

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

942

#

943

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

Dmitry Frenkel

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

[diff] [blame]

944

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

Bu Sun Kim

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

[diff] [blame]

945

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

Dmitry Frenkel

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

[diff] [blame]

946

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

947

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

948

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

949

{

950

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

951

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

952

{

953

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

954

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

955

},

956

],

957

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

958

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

959

},

960

],

961

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

962

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

Bu Sun Kim

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

[diff] [blame]

963

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

Dmitry Frenkel

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

[diff] [blame]

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

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

Bu Sun Kim

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

[diff] [blame]

974

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

975

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

Takashi Matsuo

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

[diff] [blame]

976

{

Bu Sun Kim

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

[diff] [blame]

977

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

Dmitry Frenkel

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

[diff] [blame]

978

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

Bu Sun Kim

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

[diff] [blame]

979

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

Takashi Matsuo

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

[diff] [blame]

980

},

981

],

Bu Sun Kim

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

[diff] [blame]

982

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

983

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

Dmitry Frenkel

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

[diff] [blame]

984

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

985

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

986

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

Bu Sun Kim

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

[diff] [blame]

987

},

Dmitry Frenkel

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

[diff] [blame]

988

"description": "A String", # An optional user-provided description of the deployment.

989

"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.

990

#

991

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

992

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

Bu Sun Kim

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

[diff] [blame]

993

"selfLink": "A String", # Output only. Server defined URL for the resource.

Dmitry Frenkel

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

[diff] [blame]

994

"manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.

Bu Sun Kim

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

[diff] [blame]

995

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

Dmitry Frenkel

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

[diff] [blame]

996

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

997

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Dmitry Frenkel

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

[diff] [blame]

1003

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

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

[diff] [blame]

1004

},

Bu Sun Kim

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

[diff] [blame]

1005

}

Takashi Matsuo

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

[diff] [blame]

1006

Bu Sun Kim

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

[diff] [blame]

1007

deletePolicy: string, Sets the policy to use for deleting resources.

1008

Allowed values

1009

ABANDON -

1010

DELETE -

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1011

preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Dmitry Frenkel

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

[diff] [blame]

1012

createPolicy: string, Sets the policy to use for creating new resources.

1013

Allowed values

1014

ACQUIRE -

1015

CREATE_OR_ACQUIRE -

Takashi Matsuo

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

[diff] [blame]

1016

1017

Returns:

1018

An object of the form:

1019

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1020

{ # Represents an Operation resource.

1021

#

1022

# Google Compute Engine has three Operation resources:

1023

#

1024

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

1025

#

1026

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

1027

#

1028

# Operations can be global, regional or zonal.

1029

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

1030

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

1031

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

1032

#

1033

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

Dmitry Frenkel

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

[diff] [blame]

1034

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

Bu Sun Kim

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

[diff] [blame]

1035

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

Dmitry Frenkel

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

[diff] [blame]

1036

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

1037

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

1038

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

1039

{

1040

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

1041

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

1042

{

1043

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

1044

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

1045

},

1046

],

1047

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

1048

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

1049

},

1050

],

1051

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

1052

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

Bu Sun Kim

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

[diff] [blame]

1053

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

Dmitry Frenkel

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

[diff] [blame]

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

Bu Sun Kim

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

[diff] [blame]

1064

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

1065

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

Takashi Matsuo

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

[diff] [blame]

1066

{

Bu Sun Kim

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

[diff] [blame]

1067

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

Dmitry Frenkel

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

[diff] [blame]

1068

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

Bu Sun Kim

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

[diff] [blame]

1069

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

Takashi Matsuo

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

[diff] [blame]

1070

},

1071

],

1072

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1073

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

Dmitry Frenkel

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

[diff] [blame]

1074

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

1075

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

1076

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

Takashi Matsuo

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1081

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1082

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

1083

1084

Args:

1085

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

Bu Sun Kim

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

[diff] [blame]

1086

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

Dan O'Meara

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

[diff] [blame]

1087

body: object, The request body.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1088

The object takes the form of:

1089

Bu Sun Kim

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

[diff] [blame]

1090

{

Bu Sun Kim

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

[diff] [blame]

1091

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

1092

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

Bu Sun Kim

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

[diff] [blame]

1093

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

1094

#

1095

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

1096

#

1097

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

1098

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1099

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

Bu Sun Kim

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

[diff] [blame]

#

#

#

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

1104

#

1105

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

1106

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1107

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

1108

#

1109

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

1110

#

1111

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

Bu Sun Kim

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

[diff] [blame]

1112

#

1113

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1114

#

1115

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

1116

"A String",

1117

],

Dmitry Frenkel

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

[diff] [blame]

1118

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

1119

#

1120

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

1121

#

1122

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

1123

#

1124

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

1125

#

1126

# Example (Comparison):

1127

#

1128

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

1129

#

1130

# Example (Equality):

1131

#

1132

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

1137

#

1138

# Example (Data Manipulation):

1139

#

1140

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

1141

#

1142

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

1143

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1144

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

1145

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

1146

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

1147

},

Bu Sun Kim

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

[diff] [blame]

1148

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

1149

},

1150

],

1151

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1152

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Sai Cheemalapati

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

[diff] [blame]

1153

#

Sai Cheemalapati

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

[diff] [blame]

1154

#

Sai Cheemalapati

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

[diff] [blame]

1155

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1156

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

Sai Cheemalapati

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

[diff] [blame]

1157

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1158

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

1159

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1160

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1161

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1162

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

1163

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1164

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1165

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1166

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

1167

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1168

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

1169

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

Bu Sun Kim

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

[diff] [blame]

1170

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

Sai Cheemalapati

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

[diff] [blame]

1171

#

Bu Sun Kim

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

[diff] [blame]

1172

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

Sai Cheemalapati

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

[diff] [blame]

1173

#

Bu Sun Kim

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

[diff] [blame]

1174

# Example Policy with multiple AuditConfigs:

1175

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1176

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

1177

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1178

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

Dmitry Frenkel

2020-10-06 16:46:05 -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

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

[diff] [blame]

1183

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

Bu Sun Kim

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

[diff] [blame]

1184

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

1185

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1186

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

1187

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1188

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

Dmitry Frenkel

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

[diff] [blame]

1189

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

1190

"ignoreChildExemptions": True or False,

Bu Sun Kim

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

[diff] [blame]

1191

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

1192

"A String",

Bu Sun Kim

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

[diff] [blame]

1193

],

Bu Sun Kim

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

[diff] [blame]

1194

},

1195

],

Jon Wayne Parrott

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

[diff] [blame]

1196

},

1197

],

Dmitry Frenkel

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

[diff] [blame]

1198

"iamOwned": True or False,

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1199

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

1200

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

Bu Sun Kim

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

[diff] [blame]

1201

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

1202

#

1203

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

1204

#

1205

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

1206

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1207

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

1212

#

1213

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

1214

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1215

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

1216

#

1217

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

1218

#

1219

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

Bu Sun Kim

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

[diff] [blame]

1220

#

1221

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1222

#

1223

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

1224

"A String",

Bu Sun Kim

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

[diff] [blame]

1225

],

Dmitry Frenkel

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

[diff] [blame]

1226

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

1227

#

1228

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

1229

#

1230

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

1231

#

1232

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

1233

#

1234

# Example (Comparison):

1235

#

1236

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

1237

#

1238

# Example (Equality):

1239

#

1240

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

1245

#

1246

# Example (Data Manipulation):

1247

#

1248

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

1249

#

1250

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

1251

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

1252

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

1253

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

1254

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

1255

},

Bu Sun Kim

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

[diff] [blame]

1256

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

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1257

},

1258

],

Bu Sun Kim

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

[diff] [blame]

1259

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

1260

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1261

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Bu Sun Kim

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

[diff] [blame]

1262

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

1263

{ # A rule to be applied in a Policy.

Bu Sun Kim

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

[diff] [blame]

1264

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

1265

"A String",

1266

],

Dmitry Frenkel

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

[diff] [blame]

1267

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

1268

"A String",

1269

],

1270

"action": "A String", # Required

1271

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

1272

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

1273

{ # A condition to be met.

1274

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

1275

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

1276

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

1277

"A String",

1278

],

1279

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

1280

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

1281

},

1282

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1284

{ # Specifies what kind of log the caller must write

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1285

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1286

"logMode": "A String",

1287

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1288

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1289

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1290

"permissionType": "A String", # The type of the permission that was checked.

1291

},

1292

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1293

},

1294

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1295

#

1296

# 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.

1297

#

1298

# Field names correspond to IAM request parameters and field values are their respective values.

1299

#

1300

# 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.

1301

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1302

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1303

"metric": "A String", # The metric to update.

1304

"field": "A String", # The field value to attribute.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1305

"customFields": [ # Custom fields.

1306

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1307

"name": "A String", # Name is the field name.

1308

"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.

1309

},

1310

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1315

"A String",

1316

],

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1317

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1318

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1319

"version": 42, # Specifies the format of the policy.

1320

#

1321

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1322

#

1323

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1324

#

1325

# * 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

1326

#

1327

# **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.

1328

#

1329

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1330

#

1331

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1332

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1333

}

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

Returns:

An object of the form:

1338

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1339

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1340

#

1341

#

1342

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1343

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1344

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1345

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1346

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1347

# **JSON example:**

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1348

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1349

# { "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]

1350

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1351

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1352

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1353

# 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]

1354

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1355

# 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]

1356

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1357

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1358

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1359

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1360

#

1361

# Example Policy with multiple AuditConfigs:

1362

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1363

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1364

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1365

# 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.

Dmitry Frenkel

2020-10-06 16:46:05 -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

2020-05-20 12:08:20 -0700

[diff] [blame]

1370

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1371

{ # Provides the configuration for logging a type of permissions. Example:

1372

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1373

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1374

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1375

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1376

"logType": "A String", # The log type that this config enables.

1377

"ignoreChildExemptions": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1378

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1379

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1380

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1381

},

1382

],

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1383

},

1384

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1385

"iamOwned": True or False,

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1386

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1387

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1388

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1389

#

1390

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1391

#

1392

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1393

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1394

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1395

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1396

#

1397

#

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1398

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1399

#

1400

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1401

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1402

# * `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.

1403

#

1404

# * `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.

1405

#

1406

# * `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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1407

#

1408

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1409

#

1410

# * `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]

1411

"A String",

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1412

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1413

"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.

1414

#

1415

# If the condition evaluates to `true`, then this binding applies to the current request.

1416

#

1417

# 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.

1418

#

1419

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1420

#

1421

# Example (Comparison):

1422

#

1423

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1424

#

1425

# Example (Equality):

1426

#

1427

# 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'"

1432

#

1433

# Example (Data Manipulation):

1434

#

1435

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1436

#

1437

# 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.

1438

"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.

1439

"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.

1440

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1441

"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.

1442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1443

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1444

},

1445

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1446

"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.

1447

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1448

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1449

"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.

1450

{ # A rule to be applied in a Policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1451

"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.

1452

"A String",

1453

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1454

"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.

1455

"A String",

1456

],

1457

"action": "A String", # Required

1458

"description": "A String", # Human-readable description of the rule.

1459

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1460

{ # A condition to be met.

1461

"iam": "A String", # Trusted attributes supplied by the IAM system.

1462

"svc": "A String", # Trusted attributes discharged by the service.

1463

"values": [ # The objects of the condition.

1464

"A String",

1465

],

1466

"op": "A String", # An operator to apply the subject with.

1467

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1468

},

1469

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1470

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1471

{ # Specifies what kind of log the caller must write

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1472

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1473

"logMode": "A String",

1474

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1475

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1476

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1477

"permissionType": "A String", # The type of the permission that was checked.

1478

},

1479

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1480

},

1481

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1482

#

1483

# 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.

1484

#

1485

# Field names correspond to IAM request parameters and field values are their respective values.

1486

#

1487

# 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.

1488

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1489

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1490

"metric": "A String", # The metric to update.

1491

"field": "A String", # The field value to attribute.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1492

"customFields": [ # Custom fields.

1493

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1494

"name": "A String", # Name is the field name.

1495

"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.

1496

},

1497

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1502

"A String",

1503

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1504

},

1505

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1506

"version": 42, # Specifies the format of the policy.

1507

#

1508

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1509

#

1510

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1511

#

1512

# * 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

1513

#

1514

# **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.

1515

#

1516

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1517

#

1518

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1523

<code class="details" id="stop">stop(project, deployment, body=None)</code>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1524

<pre>Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.

1525

1526

Args:

1527

project: string, The project ID for this request. (required)

1528

deployment: string, The name of the deployment for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1529

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1530

The object takes the form of:

1531

1532

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1533

"fingerprint": "A String", # Specifies a fingerprint for `stop()` requests. A fingerprint is a randomly generated value that must be provided in `stop()` requests to perform optimistic locking. This ensures optimistic concurrency so that the deployment does not have conflicting requests (e.g. if someone attempts to make a new update request while another user attempts to stop an ongoing update request, this would prevent a collision).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1534

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1535

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify a deployment. To get the latest fingerprint value, perform a `get()` request on the deployment.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}

Returns:

An object of the form:

1541

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1542

{ # Represents an Operation resource.

1543

#

1544

# Google Compute Engine has three Operation resources:

1545

#

1546

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1547

#

1548

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1549

#

1550

# Operations can be global, regional or zonal.

1551

# - For global operations, use the `globalOperations` resource.

1552

# - For regional operations, use the `regionOperations` resource.

1553

# - For zonal operations, use the `zonalOperations` resource.

1554

#

1555

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1556

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1557

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1558

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1559

"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.

1560

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1561

{

1562

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1563

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1564

{

1565

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1566

"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).

1567

},

1568

],

1569

"message": "A String", # [Output Only] A human-readable description of the warning code.

1570

"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.

1571

},

1572

],

1573

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1574

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1575

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1576

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1577

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1578

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1579

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1580

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1581

"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.

1582

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1583

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1584

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1585

"name": "A String", # [Output Only] Name of the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1586

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1587

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1588

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1589

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1590

"code": "A String", # [Output Only] The error type identifier for this error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1591

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1592

},

1593

],

1594

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1595

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1596

"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.

1597

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1598

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1603

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1604

<pre>Returns permissions that a caller has on the specified resource.

1605

1606

Args:

1607

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1608

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1609

body: object, The request body.

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

1610

The object takes the form of:

1611

1612

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1613

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1614

"A String",

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

1621

1622

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1623

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1624

"A String",

Sai Cheemalapati

2016-10-12 14:05:53 -0700

[diff] [blame]

],

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1630

<code class="details" id="update">update(project, deployment, body=None, deletePolicy=None, createPolicy=None, preview=None)</code>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1631

<pre>Updates a deployment and all of the resources described by the deployment manifest.

1632

1633

Args:

1634

project: string, The project ID for this request. (required)

1635

deployment: string, The name of the deployment for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1636

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1637

The object takes the form of:

1638

1639

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1640

"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1641

{

1642

"key": "A String",

1643

"value": "A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1644

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1645

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1646

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

1647

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

1648

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

1649

"imports": [ # Specifies any files to import for this configuration. This can be used to import templates or other files. For example, you might import a text file in order to use the file in a template.

1650

{

1651

"name": "A String", # The name of the file.

1652

"content": "A String", # The contents of the file.

1653

},

1654

],

1655

"config": { # The configuration to use for this deployment.

1656

"content": "A String", # The contents of the file.

1657

},

1658

},

1659

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1660

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

1661

#

1662

# Google Compute Engine has three Operation resources:

1663

#

1664

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1665

#

1666

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1667

#

1668

# Operations can be global, regional or zonal.

1669

# - For global operations, use the `globalOperations` resource.

1670

# - For regional operations, use the `regionOperations` resource.

1671

# - For zonal operations, use the `zonalOperations` resource.

1672

#

1673

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1674

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1675

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1676

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1677

"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.

1678

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1679

{

1680

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1681

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1682

{

1683

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1684

"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).

1685

},

1686

],

1687

"message": "A String", # [Output Only] A human-readable description of the warning code.

1688

"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.

1689

},

1690

],

1691

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1692

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1693

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1694

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1695

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1696

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1697

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1698

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1699

"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.

1700

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1701

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1702

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1703

"name": "A String", # [Output Only] Name of the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1704

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1705

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1706

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1707

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1708

"code": "A String", # [Output Only] The error type identifier for this error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1709

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1710

},

1711

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1712

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1713

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1714

"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.

1715

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1716

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1717

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1718

"description": "A String", # An optional user-provided description of the deployment.

1719

"fingerprint": "A String", # Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time.

1720

#

1721

# The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment.

1722

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

"selfLink": "A String", # Output only. Server defined URL for the resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1724

"manifest": "A String", # Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1725

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1726

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1727

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1733

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1734

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1735

}

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1736

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1737

deletePolicy: string, Sets the policy to use for deleting resources.

1738

Allowed values

1739

ABANDON -

1740

DELETE -

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1741

createPolicy: string, Sets the policy to use for creating new resources.

1742

Allowed values

1743

ACQUIRE -

1744

CREATE_OR_ACQUIRE -

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1745

preview: boolean, If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a `target.config` with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the `update()` or you can `cancelPreview()` to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1746

1747

Returns:

1748

An object of the form:

1749

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1750

{ # Represents an Operation resource.

1751

#

1752

# Google Compute Engine has three Operation resources:

1753

#

1754

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1755

#

1756

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1757

#

1758

# Operations can be global, regional or zonal.

1759

# - For global operations, use the `globalOperations` resource.

1760

# - For regional operations, use the `regionOperations` resource.

1761

# - For zonal operations, use the `zonalOperations` resource.

1762

#

1763

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1764

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1765

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1766

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1767

"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.

1768

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1769

{

1770

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1771

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1772

{

1773

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1774

"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).

1775

},

1776

],

1777

"message": "A String", # [Output Only] A human-readable description of the warning code.

1778

"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.

1779

},

1780

],

1781

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1782

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1783

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1784

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1785

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1786

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1787

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1788

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1789

"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.

1790

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1791

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1792

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1793

"name": "A String", # [Output Only] Name of the operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1794

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1795

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1796

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1797

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1798

"code": "A String", # [Output Only] The error type identifier for this error.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1799

"message": "A String", # [Output Only] An optional, human-readable error message.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1800

},

1801

],

1802

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1803

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1804

"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.

1805

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1806

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

Takashi Matsuo