Blame - docs/dyn/deploymentmanager_alpha.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>

Sai Cheemalapati

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

[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

Sai Cheemalapati

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

[diff] [blame]

84

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

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

Bu Sun Kim

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

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

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

92

Dan O'Meara

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

[diff] [blame]

93

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

Sai Cheemalapati

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

[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, filter=None, returnPartialSuccess=None, pageToken=None, orderBy=None, maxResults=None)</a></code></p>

Sai Cheemalapati

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

[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, preview=None, deletePolicy=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>

Sai Cheemalapati

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

[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

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

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

Sai Cheemalapati

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

[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

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

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

Sai Cheemalapati

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

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

Sai Cheemalapati

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

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

Sai Cheemalapati

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

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

Sai Cheemalapati

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

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

Sai Cheemalapati

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

[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 ==)

Bu Sun Kim

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

[diff] [blame]

151

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

Bu Sun Kim

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

[diff] [blame]

152

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

Dmitry Frenkel

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

[diff] [blame^]

153

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

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

Dmitry Frenkel

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

[diff] [blame^]

158

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

159

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

160

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

161

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

162

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

Bu Sun Kim

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

[diff] [blame]

163

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

Dmitry Frenkel

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

[diff] [blame^]

164

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

165

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

166

{

Dmitry Frenkel

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

[diff] [blame^]

167

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

Bu Sun Kim

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

[diff] [blame]

168

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

169

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

170

{

171

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

172

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

173

},

174

],

Dmitry Frenkel

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

[diff] [blame^]

175

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

Bu Sun Kim

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

[diff] [blame]

176

},

177

],

Dmitry Frenkel

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

[diff] [blame^]

178

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

179

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

180

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

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.

183

{

184

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

185

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

186

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

},

],

},

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

191

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

192

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

193

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

194

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

199

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

200

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

204

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

205

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

206

207

Args:

208

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

209

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

210

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

Allowed values

ABANDON -

DELETE -

Returns:

An object of the form:

217

Bu Sun Kim

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

[diff] [blame]

218

{ # Represents an Operation resource.

219

#

220

# Google Compute Engine has three Operation resources:

221

#

222

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

223

#

224

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

225

#

226

# Operations can be global, regional or zonal.

227

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

228

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

229

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

230

#

231

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

Bu Sun Kim

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

[diff] [blame]

232

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

Bu Sun Kim

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

[diff] [blame]

233

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

Dmitry Frenkel

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

[diff] [blame^]

234

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

235

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

Bu Sun Kim

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

[diff] [blame]

236

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

237

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

Bu Sun Kim

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

[diff] [blame]

238

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

Dmitry Frenkel

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

[diff] [blame^]

239

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

240

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

241

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

242

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

243

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

Bu Sun Kim

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

[diff] [blame]

244

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

Dmitry Frenkel

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

[diff] [blame^]

245

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

246

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

247

{

Dmitry Frenkel

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

[diff] [blame^]

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

{

252

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

253

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

254

},

255

],

Dmitry Frenkel

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

[diff] [blame^]

256

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

Bu Sun Kim

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

[diff] [blame]

257

},

258

],

Dmitry Frenkel

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

[diff] [blame^]

259

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

260

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

261

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

262

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

263

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

264

{

265

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

266

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

267

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

},

],

},

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

272

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

273

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

274

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

275

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

281

<pre>Gets information about a specific deployment.

282

283

Args:

284

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

285

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

286

287

Returns:

288

An object of the form:

289

290

{

Dmitry Frenkel

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

[diff] [blame^]

291

"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])?)?`.

{

"key": "A String",

"value": "A String",

},

],

"id": "A String",

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

299

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

300

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

301

{ # Output object for Deployments

302

"value": "A String", # Value of the label

303

"key": "A String", # Key of the output

304

},

305

],

306

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

307

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

308

"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])?)?`.

Sai Cheemalapati

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

[diff] [blame]

309

{

Dmitry Frenkel

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

[diff] [blame^]

310

"value": "A String",

311

"key": "A String",

Sai Cheemalapati

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

[diff] [blame]

312

},

313

],

Dmitry Frenkel

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

[diff] [blame^]

314

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

315

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview.

316

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

317

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

318

"password": "A String",

319

"user": "A String",

320

},

321

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

322

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

323

},

324

},

Sai Cheemalapati

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

[diff] [blame]

325

},

Dmitry Frenkel

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

[diff] [blame^]

326

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

327

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

328

#

329

# Google Compute Engine has three Operation resources:

330

#

331

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

332

#

333

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

334

#

335

# Operations can be global, regional or zonal.

336

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

337

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

338

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

339

#

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

{

357

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

358

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

359

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

360

{

361

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

362

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

363

},

364

],

365

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

366

},

367

],

368

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

369

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

370

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

371

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

372

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

Sai Cheemalapati

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

[diff] [blame]

373

{

Dmitry Frenkel

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

[diff] [blame^]

374

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

375

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

376

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

Sai Cheemalapati

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

[diff] [blame]

377

},

378

],

379

},

Dmitry Frenkel

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

[diff] [blame^]

380

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

381

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

382

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

383

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

384

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

Sai Cheemalapati

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

[diff] [blame]

385

},

Dmitry Frenkel

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

[diff] [blame^]

386

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment.

387

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

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

[diff] [blame]

388

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

389

"password": "A String",

390

"user": "A String",

391

},

392

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

393

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

394

},

Sai Cheemalapati

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

[diff] [blame]

395

},

Dmitry Frenkel

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

[diff] [blame^]

396

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

397

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

398

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

399

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

400

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

401

{

402

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

403

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

404

},

405

],

406

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

407

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

Bu Sun Kim

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

[diff] [blame]

408

},

Dmitry Frenkel

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

[diff] [blame^]

409

},

410

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

411

#

412

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

413

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

417

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

Sai Cheemalapati

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

[diff] [blame]

418

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

419

420

Args:

421

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

Bu Sun Kim

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

[diff] [blame]

422

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

Bu Sun Kim

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

[diff] [blame]

423

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

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

[diff] [blame]

424

425

Returns:

426

An object of the form:

427

Bu Sun Kim

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

[diff] [blame]

428

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

Sai Cheemalapati

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

[diff] [blame]

429

#

430

#

431

#

Bu Sun Kim

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

[diff] [blame]

432

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

Sai Cheemalapati

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

[diff] [blame]

433

#

Bu Sun Kim

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

[diff] [blame]

434

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

Sai Cheemalapati

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

[diff] [blame]

435

#

Bu Sun Kim

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

[diff] [blame]

436

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

437

#

Bu Sun Kim

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

[diff] [blame]

438

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

439

#

Bu Sun Kim

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

[diff] [blame]

440

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

441

#

Bu Sun Kim

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

[diff] [blame]

442

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

443

#

Bu Sun Kim

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

[diff] [blame]

444

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

Dmitry Frenkel

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

[diff] [blame^]

445

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

446

{ # A rule to be applied in a Policy.

447

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

Bu Sun Kim

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

[diff] [blame]

448

"A String",

449

],

Dmitry Frenkel

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

[diff] [blame^]

450

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

451

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

452

{ # Specifies what kind of log the caller must write

453

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

454

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

455

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

456

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

457

},

458

},

459

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

460

#

461

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

462

#

463

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

464

#

465

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

466

#

467

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

468

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

469

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

470

"customFields": [ # Custom fields.

471

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

472

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

473

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

},

],

},

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

478

"logMode": "A String",

},

},

],

"action": "A String", # Required

483

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

484

"A String",

485

],

486

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

487

"A String",

488

],

489

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

490

{ # A condition to be met.

491

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

492

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

493

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

494

"A String",

495

],

496

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

497

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

498

},

499

],

Sai Cheemalapati

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

[diff] [blame]

500

},

501

],

Dmitry Frenkel

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

[diff] [blame^]

502

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

503

#

504

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

505

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

506

#

507

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

508

#

509

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

510

#

511

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

512

#

513

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

514

#

515

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

516

#

517

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

518

"iamOwned": True or False,

Bu Sun Kim

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

[diff] [blame]

519

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

Sai Cheemalapati

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

[diff] [blame]

520

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

Dmitry Frenkel

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

[diff] [blame^]

521

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

522

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

523

#

524

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

525

#

526

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

527

#

528

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

#

#

#

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

533

#

534

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

535

#

536

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

537

#

538

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

539

#

540

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

545

"A String",

546

],

Bu Sun Kim

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

[diff] [blame]

547

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

Bu Sun Kim

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

[diff] [blame]

548

#

Bu Sun Kim

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

[diff] [blame]

549

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

550

#

551

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

552

#

553

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

554

#

555

# Example (Comparison):

556

#

557

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

558

#

559

# Example (Equality):

560

#

561

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

566

#

567

# Example (Data Manipulation):

568

#

569

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

570

#

571

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

572

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

Bu Sun Kim

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

[diff] [blame]

573

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

Bu Sun Kim

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

[diff] [blame]

574

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

Dmitry Frenkel

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

[diff] [blame^]

575

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

Bu Sun Kim

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

[diff] [blame]

576

},

Sai Cheemalapati

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

[diff] [blame]

577

},

578

],

Dmitry Frenkel

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

[diff] [blame^]

579

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

580

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

581

#

582

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

583

#

584

# Example Policy with multiple AuditConfigs:

585

#

586

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

587

#

588

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

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

593

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

594

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

595

#

596

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

597

#

598

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

599

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

600

"ignoreChildExemptions": True or False,

601

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

606

},

607

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

612

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

Sai Cheemalapati

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

[diff] [blame]

613

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

614

615

Args:

616

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

Dan O'Meara

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

[diff] [blame]

617

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

618

The object takes the form of:

619

620

{

Dmitry Frenkel

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

[diff] [blame^]

621

"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])?)?`.

{

"key": "A String",

"value": "A String",

},

],

"id": "A String",

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

629

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

630

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

631

{ # Output object for Deployments

632

"value": "A String", # Value of the label

633

"key": "A String", # Key of the output

634

},

635

],

636

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

637

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

638

"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])?)?`.

Sai Cheemalapati

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

[diff] [blame]

639

{

Dmitry Frenkel

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

[diff] [blame^]

640

"value": "A String",

641

"key": "A String",

Sai Cheemalapati

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

[diff] [blame]

642

},

643

],

Dmitry Frenkel

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

[diff] [blame^]

644

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

645

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview.

646

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

647

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

648

"password": "A String",

649

"user": "A String",

650

},

651

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

652

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

653

},

654

},

Sai Cheemalapati

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

[diff] [blame]

655

},

Dmitry Frenkel

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

[diff] [blame^]

656

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

657

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

658

#

659

# Google Compute Engine has three Operation resources:

660

#

661

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

662

#

663

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

664

#

665

# Operations can be global, regional or zonal.

666

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

667

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

668

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

669

#

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

{

687

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

688

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

689

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

690

{

691

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

692

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

693

},

694

],

695

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

696

},

697

],

698

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

699

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

700

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

701

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

702

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

Sai Cheemalapati

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

[diff] [blame]

703

{

Dmitry Frenkel

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

[diff] [blame^]

704

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

705

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

706

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

Sai Cheemalapati

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

[diff] [blame]

707

},

708

],

709

},

Dmitry Frenkel

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

[diff] [blame^]

710

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

711

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

712

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

713

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

714

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

Sai Cheemalapati

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

[diff] [blame]

715

},

Dmitry Frenkel

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

[diff] [blame^]

716

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment.

717

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

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

[diff] [blame]

718

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

719

"password": "A String",

720

"user": "A String",

721

},

722

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

723

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

724

},

Sai Cheemalapati

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

[diff] [blame]

725

},

Dmitry Frenkel

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

[diff] [blame^]

726

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

727

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

728

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

729

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

730

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

731

{

732

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

733

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

734

},

735

],

736

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

737

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

Bu Sun Kim

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

[diff] [blame]

738

},

Dmitry Frenkel

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

[diff] [blame^]

739

},

740

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

741

#

742

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

743

}

Sai Cheemalapati

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

[diff] [blame]

744

Bu Sun Kim

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

[diff] [blame]

745

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

Allowed values

ACQUIRE -

CREATE -

CREATE_OR_ACQUIRE -

Bu Sun Kim

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

[diff] [blame]

750

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.

Sai Cheemalapati

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

[diff] [blame]

751

752

Returns:

753

An object of the form:

754

Bu Sun Kim

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

[diff] [blame]

755

{ # Represents an Operation resource.

756

#

757

# Google Compute Engine has three Operation resources:

758

#

759

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

760

#

761

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

762

#

763

# Operations can be global, regional or zonal.

764

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

765

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

766

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

767

#

768

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

Bu Sun Kim

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

[diff] [blame]

769

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

Bu Sun Kim

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

[diff] [blame]

770

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

Dmitry Frenkel

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

[diff] [blame^]

771

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

772

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

Bu Sun Kim

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

[diff] [blame]

773

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

774

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

Bu Sun Kim

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

[diff] [blame]

775

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

Dmitry Frenkel

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

[diff] [blame^]

776

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

777

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

778

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

779

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

780

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

Bu Sun Kim

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

[diff] [blame]

781

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

Dmitry Frenkel

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

[diff] [blame^]

782

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

783

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

784

{

Dmitry Frenkel

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

[diff] [blame^]

785

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

Bu Sun Kim

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

[diff] [blame]

786

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

787

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

788

{

789

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

790

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

791

},

792

],

Dmitry Frenkel

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

[diff] [blame^]

793

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

Bu Sun Kim

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

[diff] [blame]

794

},

795

],

Dmitry Frenkel

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

[diff] [blame^]

796

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

797

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

798

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

799

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

800

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

801

{

802

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

803

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

804

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

},

],

},

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

809

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

810

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

811

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

812

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

817

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

Sai Cheemalapati

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

[diff] [blame]

818

<pre>Lists all deployments for a given project.

819

820

Args:

821

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

Bu Sun Kim

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

[diff] [blame]

822

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

Sai Cheemalapati

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

[diff] [blame]

823

Bu Sun Kim

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

[diff] [blame]

824

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

Sai Cheemalapati

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

[diff] [blame]

825

Bu Sun Kim

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

[diff] [blame]

826

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

Sai Cheemalapati

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

[diff] [blame]

827

Bu Sun Kim

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

[diff] [blame]

828

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

Dmitry Frenkel

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

[diff] [blame^]

829

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

830

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.

Bu Sun Kim

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

[diff] [blame]

831

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

832

Bu Sun Kim

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

[diff] [blame]

833

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.

Bu Sun Kim

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

[diff] [blame]

834

Bu Sun Kim

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

[diff] [blame]

835

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

Dmitry Frenkel

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

[diff] [blame^]

836

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

Sai Cheemalapati

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

[diff] [blame]

837

838

Returns:

839

An object of the form:

840

841

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

Bu Sun Kim

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

[diff] [blame]

842

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

Sai Cheemalapati

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

[diff] [blame]

843

{

Dmitry Frenkel

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

[diff] [blame^]

844

"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])?)?`.

{

"key": "A String",

"value": "A String",

},

],

"id": "A String",

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

852

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

853

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

854

{ # Output object for Deployments

855

"value": "A String", # Value of the label

856

"key": "A String", # Key of the output

857

},

858

],

859

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

860

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

861

"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])?)?`.

Sai Cheemalapati

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

[diff] [blame]

862

{

Dmitry Frenkel

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

[diff] [blame^]

863

"value": "A String",

864

"key": "A String",

Sai Cheemalapati

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

[diff] [blame]

865

},

866

],

Dmitry Frenkel

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

[diff] [blame^]

867

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

868

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview.

869

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

870

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

871

"password": "A String",

872

"user": "A String",

873

},

874

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

875

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

876

},

877

},

Sai Cheemalapati

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

[diff] [blame]

878

},

Dmitry Frenkel

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

[diff] [blame^]

879

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

880

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

881

#

882

# Google Compute Engine has three Operation resources:

883

#

884

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

885

#

886

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

887

#

888

# Operations can be global, regional or zonal.

889

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

890

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

891

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

892

#

893

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

894

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

895

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

896

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

897

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

898

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

899

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

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

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

908

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

909

{

910

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

911

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

912

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

913

{

914

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

915

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

916

},

917

],

918

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

919

},

920

],

921

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

922

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

923

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

924

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

925

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

Sai Cheemalapati

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

[diff] [blame]

926

{

Dmitry Frenkel

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

[diff] [blame^]

927

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

928

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

929

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

Sai Cheemalapati

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

[diff] [blame]

930

},

931

],

932

},

Dmitry Frenkel

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

[diff] [blame^]

933

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

934

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

935

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

936

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

937

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

Bu Sun Kim

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

[diff] [blame]

938

},

Dmitry Frenkel

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

[diff] [blame^]

939

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment.

940

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

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

[diff] [blame]

941

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

942

"password": "A String",

943

"user": "A String",

944

},

945

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

946

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

947

},

Bu Sun Kim

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

[diff] [blame]

948

},

Dmitry Frenkel

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

[diff] [blame^]

949

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

950

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

951

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

952

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

953

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

954

{

955

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

956

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

957

},

958

],

959

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

960

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

Bu Sun Kim

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

[diff] [blame]

961

},

Dmitry Frenkel

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

[diff] [blame^]

962

},

963

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

964

#

965

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

Bu Sun Kim

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

[diff] [blame]

966

},

Sai Cheemalapati

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

[diff] [blame]

967

],

Bu Sun Kim

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

[diff] [blame]

968

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

974

<pre>Retrieves the next page of results.

975

976

Args:

977

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

978

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

979

980

Returns:

Bu Sun Kim

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

[diff] [blame]

981

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

Sai Cheemalapati

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

[diff] [blame]

982

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

987

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

Bu Sun Kim

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

[diff] [blame]

988

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

Sai Cheemalapati

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

[diff] [blame]

989

990

Args:

991

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

992

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

Dan O'Meara

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

[diff] [blame]

993

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

994

The object takes the form of:

995

996

{

Dmitry Frenkel

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

[diff] [blame^]

997

"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])?)?`.

{

"key": "A String",

"value": "A String",

},

],

"id": "A String",

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

1005

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

1006

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

1007

{ # Output object for Deployments

1008

"value": "A String", # Value of the label

1009

"key": "A String", # Key of the output

1010

},

1011

],

1012

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

1013

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

1014

"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])?)?`.

Sai Cheemalapati

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

[diff] [blame]

1015

{

Dmitry Frenkel

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

[diff] [blame^]

1016

"value": "A String",

1017

"key": "A String",

Sai Cheemalapati

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

[diff] [blame]

1018

},

1019

],

Dmitry Frenkel

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

[diff] [blame^]

1020

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

1021

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview.

1022

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

1023

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1024

"password": "A String",

1025

"user": "A String",

1026

},

1027

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1028

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1029

},

1030

},

Sai Cheemalapati

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

[diff] [blame]

1031

},

Dmitry Frenkel

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

[diff] [blame^]

1032

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

1033

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

1034

#

1035

# Google Compute Engine has three Operation resources:

1036

#

1037

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

1038

#

1039

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

1040

#

1041

# Operations can be global, regional or zonal.

1042

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

1043

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

1044

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

1045

#

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

{

1063

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

1064

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

1065

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

1066

{

1067

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

1068

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

1069

},

1070

],

1071

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

1072

},

1073

],

1074

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

1075

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

1076

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

1077

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

1078

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

Sai Cheemalapati

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

[diff] [blame]

1079

{

Dmitry Frenkel

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

[diff] [blame^]

1080

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

1081

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

1082

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

Sai Cheemalapati

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

[diff] [blame]

1083

},

1084

],

1085

},

Dmitry Frenkel

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

[diff] [blame^]

1086

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

1087

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

1088

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

1089

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

1090

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

Sai Cheemalapati

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

[diff] [blame]

1091

},

Dmitry Frenkel

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

[diff] [blame^]

1092

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment.

1093

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

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

[diff] [blame]

1094

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1095

"password": "A String",

1096

"user": "A String",

1097

},

1098

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1099

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1100

},

Sai Cheemalapati

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

[diff] [blame]

1101

},

Dmitry Frenkel

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

[diff] [blame^]

1102

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

1103

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

1104

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

1105

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

1106

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

1107

{

1108

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

1109

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

1110

},

1111

],

1112

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

1113

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

Bu Sun Kim

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

[diff] [blame]

1114

},

Dmitry Frenkel

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

[diff] [blame^]

1115

},

1116

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

1117

#

1118

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

1119

}

Sai Cheemalapati

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

[diff] [blame]

1120

Dmitry Frenkel

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

[diff] [blame^]

1121

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.

1122

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

1123

Allowed values

1124

ABANDON -

1125

DELETE -

Sai Cheemalapati

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

[diff] [blame]

1126

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

1127

Allowed values

1128

ACQUIRE -

Bu Sun Kim

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

[diff] [blame]

1129

CREATE -

Sai Cheemalapati

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

[diff] [blame]

1130

CREATE_OR_ACQUIRE -

Sai Cheemalapati

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

[diff] [blame]

1131

1132

Returns:

1133

An object of the form:

1134

Bu Sun Kim

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

[diff] [blame]

1135

{ # Represents an Operation resource.

1136

#

1137

# Google Compute Engine has three Operation resources:

1138

#

1139

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

1140

#

1141

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

1142

#

1143

# Operations can be global, regional or zonal.

1144

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

1145

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

1146

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

1147

#

1148

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

Bu Sun Kim

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

[diff] [blame]

1149

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

Bu Sun Kim

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

[diff] [blame]

1150

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

Dmitry Frenkel

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

[diff] [blame^]

1151

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

1152

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

Bu Sun Kim

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

[diff] [blame]

1153

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

1154

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

Bu Sun Kim

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

[diff] [blame]

1155

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

Dmitry Frenkel

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

[diff] [blame^]

1156

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

1157

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

1158

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

1159

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

1160

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

Bu Sun Kim

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

[diff] [blame]

1161

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

Dmitry Frenkel

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

[diff] [blame^]

1162

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

1163

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

1164

{

Dmitry Frenkel

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

[diff] [blame^]

1165

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

Bu Sun Kim

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

[diff] [blame]

1166

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

1167

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

1168

{

1169

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

1170

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

1171

},

1172

],

Dmitry Frenkel

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

[diff] [blame^]

1173

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

Bu Sun Kim

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

[diff] [blame]

1174

},

1175

],

Dmitry Frenkel

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

[diff] [blame^]

1176

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

1177

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

1178

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

1179

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

1180

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

1181

{

1182

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

1183

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

1184

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

},

],

},

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

1189

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

1190

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

1191

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

1192

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1197

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

Sai Cheemalapati

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

[diff] [blame]

1198

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

1199

1200

Args:

1201

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

Bu Sun Kim

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

[diff] [blame]

1202

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

Dan O'Meara

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

[diff] [blame]

1203

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1204

The object takes the form of:

1205

Bu Sun Kim

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

[diff] [blame]

1206

{

Bu Sun Kim

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

[diff] [blame]

1207

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

1208

#

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

1209

#

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

1210

#

Bu Sun Kim

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

[diff] [blame]

1211

# 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

4ba8c23

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

[diff] [blame]

1212

#

Bu Sun Kim

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

[diff] [blame]

1213

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

1214

#

Bu Sun Kim

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

[diff] [blame]

1215

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

1216

#

Bu Sun Kim

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

[diff] [blame]

1217

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

1218

#

Bu Sun Kim

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

[diff] [blame]

1219

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

1220

#

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

#

Bu Sun Kim

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

[diff] [blame]

1223

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

Dmitry Frenkel

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

[diff] [blame^]

1224

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

1225

{ # A rule to be applied in a Policy.

1226

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

Bu Sun Kim

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

[diff] [blame]

1227

"A String",

1228

],

Dmitry Frenkel

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

[diff] [blame^]

1229

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

1230

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

1231

{ # Specifies what kind of log the caller must write

1232

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

1233

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

1234

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

1235

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

1236

},

1237

},

1238

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

1239

#

1240

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

1241

#

1242

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

1243

#

1244

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

1245

#

1246

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

1247

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

1248

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

1249

"customFields": [ # Custom fields.

1250

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

1251

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

1252

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

},

],

},

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

1257

"logMode": "A String",

},

},

],

"action": "A String", # Required

1262

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

1263

"A String",

1264

],

1265

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

1266

"A String",

1267

],

1268

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

1269

{ # A condition to be met.

1270

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

1271

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

1272

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

1273

"A String",

1274

],

1275

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

1276

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

1277

},

1278

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1279

},

1280

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1281

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

1282

#

1283

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

1284

"version": 42, # Specifies the format of the policy.

1285

#

1286

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1287

#

1288

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1289

#

1290

# * 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

1291

#

1292

# **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.

1293

#

1294

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1295

#

1296

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1297

"iamOwned": True or False,

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1298

"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]

1299

{ # Associates `members` with a `role`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1300

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1301

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1302

#

1303

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1304

#

1305

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1306

#

1307

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1312

#

1313

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1314

#

1315

# * `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.

1316

#

1317

# * `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.

1318

#

1319

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

1324

"A String",

1325

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1326

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1327

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1328

# If the condition evaluates to `true`, then this binding applies to the current request.

1329

#

1330

# 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.

1331

#

1332

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1333

#

1334

# Example (Comparison):

1335

#

1336

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1337

#

1338

# Example (Equality):

1339

#

1340

# 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'"

1345

#

1346

# Example (Data Manipulation):

1347

#

1348

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1349

#

1350

# 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.

1351

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1352

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1353

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1354

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1355

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1356

},

1357

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1358

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1359

{ # 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.

1360

#

1361

# 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.

1362

#

1363

# Example Policy with multiple AuditConfigs:

1364

#

1365

# { "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" ] } ] } ] }

1366

#

1367

# 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.

"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.

1372

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1373

{ # Provides the configuration for logging a type of permissions. Example:

1374

#

1375

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

1376

#

1377

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1378

"logType": "A String", # The log type that this config enables.

1379

"ignoreChildExemptions": True or False,

1380

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1385

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1386

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1387

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1388

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

1389

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1390

{ # Associates `members` with a `role`.

1391

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1392

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1393

#

1394

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1395

#

1396

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1397

#

1398

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1403

#

1404

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1405

#

1406

# * `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.

1407

#

1408

# * `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.

1409

#

1410

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1415

"A String",

1416

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1417

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1419

# If the condition evaluates to `true`, then this binding applies to the current request.

1420

#

1421

# 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.

1422

#

1423

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1424

#

1425

# Example (Comparison):

1426

#

1427

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1428

#

1429

# Example (Equality):

1430

#

1431

# 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'"

1436

#

1437

# Example (Data Manipulation):

1438

#

1439

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1440

#

1441

# 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.

1442

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1443

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1444

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1445

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1446

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

},

],

}

Returns:

An object of the form:

1454

1455

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

1460

#

1461

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

1470

#

1471

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

1472

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

1473

{ # A rule to be applied in a Policy.

1474

"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.

1475

"A String",

1476

],

1477

"description": "A String", # Human-readable description of the rule.

1478

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1479

{ # Specifies what kind of log the caller must write

1480

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1481

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1482

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1483

"permissionType": "A String", # The type of the permission that was checked.

1484

},

1485

},

1486

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1487

#

1488

# 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.

1489

#

1490

# Field names correspond to IAM request parameters and field values are their respective values.

1491

#

1492

# 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.

1493

#

1494

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1495

"metric": "A String", # The metric to update.

1496

"field": "A String", # The field value to attribute.

1497

"customFields": [ # Custom fields.

1498

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1499

"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.

1500

"name": "A String", # Name is the field name.

},

],

},

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

1505

"logMode": "A String",

},

},

],

"action": "A String", # Required

1510

"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.

1511

"A String",

1512

],

1513

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1514

"A String",

1515

],

1516

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1517

{ # A condition to be met.

1518

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

1519

"iam": "A String", # Trusted attributes supplied by the IAM system.

1520

"values": [ # The objects of the condition.

1521

"A String",

1522

],

1523

"svc": "A String", # Trusted attributes discharged by the service.

1524

"op": "A String", # An operator to apply the subject with.

},

],

},

],

"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.

1530

#

1531

# **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.

1532

"version": 42, # Specifies the format of the policy.

1533

#

1534

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1535

#

1536

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1537

#

1538

# * 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

1539

#

1540

# **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.

1541

#

1542

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1543

#

1544

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1545

"iamOwned": True or False,

1546

"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.

1547

{ # Associates `members` with a `role`.

1548

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1549

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1550

#

1551

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1552

#

1553

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1554

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1555

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1560

#

1561

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1562

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1563

# * `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.

1564

#

1565

# * `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.

1566

#

1567

# * `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]

1568

#

1569

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1570

#

1571

# * `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]

1572

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1573

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1574

"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.

1575

#

1576

# If the condition evaluates to `true`, then this binding applies to the current request.

1577

#

1578

# 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.

1579

#

1580

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1581

#

1582

# Example (Comparison):

1583

#

1584

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1585

#

1586

# Example (Equality):

1587

#

1588

# 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'"

1593

#

1594

# Example (Data Manipulation):

1595

#

1596

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1597

#

1598

# 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.

1599

"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.

1600

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1601

"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.

1602

"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.

1603

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1604

},

1605

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1606

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

1607

{ # 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.

1608

#

1609

# 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.

1610

#

1611

# Example Policy with multiple AuditConfigs:

1612

#

1613

# { "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" ] } ] } ] }

1614

#

1615

# 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.

"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.

1620

"auditLogConfigs": [ # The configuration for logging of each type of permission.

1621

{ # Provides the configuration for logging a type of permissions. Example:

1622

#

1623

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

1624

#

1625

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1626

"logType": "A String", # The log type that this config enables.

1627

"ignoreChildExemptions": True or False,

1628

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1633

},

1634

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1639

<code class="details" id="stop">stop(project, deployment, body=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1640

<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.

1641

1642

Args:

1643

project: string, The project ID for this request. (required)

1644

deployment: string, The name of the deployment for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1645

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1646

The object takes the form of:

1647

1648

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1649

"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).

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1650

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1651

# 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}

Returns:

An object of the form:

1657

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1658

{ # Represents an Operation resource.

1659

#

1660

# Google Compute Engine has three Operation resources:

1661

#

1662

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1663

#

1664

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1665

#

1666

# Operations can be global, regional or zonal.

1667

# - For global operations, use the `globalOperations` resource.

1668

# - For regional operations, use the `regionOperations` resource.

1669

# - For zonal operations, use the `zonalOperations` resource.

1670

#

1671

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1672

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1673

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1674

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1675

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1676

"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^]

1677

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1678

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1679

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1680

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1681

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1682

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1683

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1684

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1685

"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]

1686

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1687

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1688

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1689

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1690

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1691

{

1692

"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).

1693

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1694

},

1695

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1696

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1697

},

1698

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1699

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1700

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1701

"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.

1702

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1703

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1704

{

1705

"code": "A String", # [Output Only] The error type identifier for this error.

1706

"message": "A String", # [Output Only] An optional, human-readable error message.

1707

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

},

],

},

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1712

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1713

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1714

"name": "A String", # [Output Only] Name of the operation.

1715

"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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1720

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1721

<pre>Returns permissions that a caller has on the specified resource.

1722

1723

Args:

1724

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1725

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1726

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1727

The object takes the form of:

1728

1729

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1730

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1731

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

],

}

Returns:

An object of the form:

1738

1739

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1740

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1741

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

],

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1747

<code class="details" id="update">update(project, deployment, body=None, deletePolicy=None, createPolicy=None, preview=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1748

<pre>Updates a deployment and all of the resources described by the deployment manifest.

1749

1750

Args:

1751

project: string, The project ID for this request. (required)

1752

deployment: string, The name of the deployment for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1753

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1754

The object takes the form of:

1755

1756

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1757

"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])?)?`.

{

"key": "A String",

"value": "A String",

},

],

"id": "A String",

"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.

1765

"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.

1766

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

1767

{ # Output object for Deployments

1768

"value": "A String", # Value of the label

1769

"key": "A String", # Key of the output

1770

},

1771

],

1772

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

1773

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

1774

"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])?)?`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1775

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1776

"value": "A String",

1777

"key": "A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1778

},

1779

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1780

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

1781

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The user-provided default credential to use when deploying this preview.

1782

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

1783

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1784

"password": "A String",

1785

"user": "A String",

1786

},

1787

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1788

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1789

},

1790

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1791

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1792

"description": "A String", # An optional user-provided description of the deployment.

1793

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

1794

#

1795

# Google Compute Engine has three Operation resources:

1796

#

1797

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1798

#

1799

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1800

#

1801

# Operations can be global, regional or zonal.

1802

# - For global operations, use the `globalOperations` resource.

1803

# - For regional operations, use the `regionOperations` resource.

1804

# - For zonal operations, use the `zonalOperations` resource.

1805

#

1806

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1807

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1808

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1809

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1810

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1811

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1812

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1813

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1814

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1815

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1816

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1817

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1818

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1819

"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.

1820

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1821

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1822

{

1823

"message": "A String", # [Output Only] A human-readable description of the warning code.

1824

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1825

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1826

{

1827

"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).

1828

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1829

},

1830

],

1831

"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.

1832

},

1833

],

1834

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1835

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1836

"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.

1837

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1838

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1839

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1840

"code": "A String", # [Output Only] The error type identifier for this error.

1841

"message": "A String", # [Output Only] An optional, human-readable error message.

1842

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1843

},

1844

],

1845

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1846

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1847

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1848

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1849

"name": "A String", # [Output Only] Name of the operation.

1850

"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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1851

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1852

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment.

1853

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1854

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1855

"password": "A String",

1856

"user": "A String",

1857

},

1858

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1859

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1860

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1861

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1862

"selfLink": "A String", # Output only. Server defined URL for the resource.

1863

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

1864

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

1865

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

1866

"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.

1867

{

1868

"name": "A String", # The name of the file.

1869

"content": "A String", # The contents of the file.

1870

},

1871

],

1872

"config": { # The configuration to use for this deployment.

1873

"content": "A String", # The contents of the file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1874

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1875

},

1876

"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.

1877

#

1878

# 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.

1879

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1880

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1881

deletePolicy: string, Sets the policy to use for deleting resources.

1882

Allowed values

1883

ABANDON -

1884

DELETE -

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1885

createPolicy: string, Sets the policy to use for creating new resources.

1886

Allowed values

1887

ACQUIRE -

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1888

CREATE -

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1889

CREATE_OR_ACQUIRE -

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1890

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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1891

1892

Returns:

1893

An object of the form:

1894

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1895

{ # Represents an Operation resource.

1896

#

1897

# Google Compute Engine has three Operation resources:

1898

#

1899

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1900

#

1901

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1902

#

1903

# Operations can be global, regional or zonal.

1904

# - For global operations, use the `globalOperations` resource.

1905

# - For regional operations, use the `regionOperations` resource.

1906

# - For zonal operations, use the `zonalOperations` resource.

1907

#

1908

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1909

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1910

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1911

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1912

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1913

"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^]

1914

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1915

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1916

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1917

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1918

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1919

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1920

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1921

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1922

"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]

1923

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1924

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1925

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1926

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1927

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1928

{

1929

"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).

1930

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1931

},

1932

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1933

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1934

},

1935

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1936

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1937

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1938

"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.

1939

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1940

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1941

{

1942

"code": "A String", # [Output Only] The error type identifier for this error.

1943

"message": "A String", # [Output Only] An optional, human-readable error message.

1944

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

},

],

},

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1949

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1950

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1951

"name": "A String", # [Output Only] Name of the operation.

1952

"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.

Sai Cheemalapati