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

81

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

82

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

83

84

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

85

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

86

Bu Sun Kim

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

[diff] [blame^]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

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

89

Dan O'Meara

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

[diff] [blame]

90

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

91

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

92

Bu Sun Kim

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

[diff] [blame^]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

<p class="firstline">Lists all deployments for a given project.</p>

95

96

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

97

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

98

Bu Sun Kim

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame^]

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Sai Cheemalapati

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

[diff] [blame]

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Sai Cheemalapati

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

[diff] [blame]

109

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

110

Bu Sun Kim

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

<h3>Method Details</h3>

114

Dan O'Meara

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

[diff] [blame]

115

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

Sai Cheemalapati

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

[diff] [blame]

116

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

117

118

Args:

119

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

120

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

Dan O'Meara

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

[diff] [blame]

121

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

122

The object takes the form of:

123

124

{

Bu Sun Kim

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

[diff] [blame^]

125

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

126

#

Bu Sun Kim

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

[diff] [blame^]

127

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

133

Bu Sun Kim

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

[diff] [blame^]

134

{ # Represents an Operation resource.

135

#

136

# Google Compute Engine has three Operation resources:

137

#

138

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

139

#

140

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

141

#

142

# Operations can be global, regional or zonal.

143

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

144

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

145

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

146

#

147

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

Bu Sun Kim

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

[diff] [blame]

148

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

149

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

150

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

151

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

152

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

153

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

Sai Cheemalapati

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

[diff] [blame]

154

{

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

157

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

Sai Cheemalapati

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

[diff] [blame]

158

},

159

],

160

},

Bu Sun Kim

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

[diff] [blame^]

161

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

162

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

163

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

164

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

Bu Sun Kim

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

[diff] [blame^]

165

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

166

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

167

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

Bu Sun Kim

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

[diff] [blame]

168

"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-27 12:20:54 -0700

[diff] [blame^]

169

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

Bu Sun Kim

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

[diff] [blame]

170

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

Bu Sun Kim

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

[diff] [blame^]

171

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

Bu Sun Kim

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

[diff] [blame]

172

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

Bu Sun Kim

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

[diff] [blame^]

173

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

Bu Sun Kim

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

[diff] [blame]

174

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

175

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

176

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

Bu Sun Kim

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

[diff] [blame^]

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

179

{

180

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

181

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

182

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

183

{

184

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

185

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

186

},

187

],

188

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

189

},

190

],

Bu Sun Kim

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

[diff] [blame^]

191

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

197

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

198

199

Args:

200

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

201

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

202

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

Allowed values

ABANDON -

DELETE -

Returns:

An object of the form:

209

Bu Sun Kim

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

[diff] [blame^]

210

{ # Represents an Operation resource.

211

#

212

# Google Compute Engine has three Operation resources:

213

#

214

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

215

#

216

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

217

#

218

# Operations can be global, regional or zonal.

219

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

220

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

221

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

222

#

223

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

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

226

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

227

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

228

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

229

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

Sai Cheemalapati

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

[diff] [blame]

230

{

Bu Sun Kim

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

[diff] [blame]

231

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

232

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

233

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

Sai Cheemalapati

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

[diff] [blame]

234

},

235

],

236

},

Bu Sun Kim

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

[diff] [blame^]

237

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

238

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

239

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

240

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

Bu Sun Kim

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

[diff] [blame^]

241

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

242

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

243

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

Bu Sun Kim

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

[diff] [blame]

244

"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-27 12:20:54 -0700

[diff] [blame^]

245

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

Bu Sun Kim

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

[diff] [blame]

246

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

Bu Sun Kim

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

[diff] [blame^]

247

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

Bu Sun Kim

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

[diff] [blame]

248

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

Bu Sun Kim

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

[diff] [blame^]

249

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

Bu Sun Kim

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

[diff] [blame]

250

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

251

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

252

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

Bu Sun Kim

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

[diff] [blame^]

253

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

Bu Sun Kim

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

[diff] [blame]

254

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

255

{

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.

257

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

258

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

259

{

260

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

261

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

262

},

263

],

264

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

265

},

266

],

Bu Sun Kim

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

[diff] [blame^]

267

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

273

<pre>Gets information about a specific deployment.

274

275

Args:

276

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

277

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

278

279

Returns:

280

An object of the form:

281

282

{

Bu Sun Kim

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

[diff] [blame]

283

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

284

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

285

"password": "A String",

286

"user": "A String",

Bu Sun Kim

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

[diff] [blame]

287

},

Bu Sun Kim

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

[diff] [blame]

288

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

289

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

290

},

291

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

292

},

293

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

Bu Sun Kim

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

[diff] [blame^]

294

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

Bu Sun Kim

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

[diff] [blame]

295

#

Bu Sun Kim

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

[diff] [blame^]

296

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

297

"id": "A String",

298

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

Bu Sun Kim

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

[diff] [blame^]

299

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Bu Sun Kim

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

[diff] [blame^]

305

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

306

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

307

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

308

#

309

# Google Compute Engine has three Operation resources:

310

#

311

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

312

#

313

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

314

#

315

# Operations can be global, regional or zonal.

316

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

317

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

318

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

319

#

320

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

Bu Sun Kim

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

[diff] [blame]

321

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

322

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

323

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

324

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

325

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

326

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

Sai Cheemalapati

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

[diff] [blame]

327

{

Bu Sun Kim

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

[diff] [blame]

328

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

329

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

330

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

Sai Cheemalapati

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

[diff] [blame]

331

},

332

],

Sai Cheemalapati

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

[diff] [blame]

333

},

Bu Sun Kim

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

[diff] [blame^]

334

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

335

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

336

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

337

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

Bu Sun Kim

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

[diff] [blame^]

338

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

339

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

340

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

Bu Sun Kim

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

[diff] [blame]

341

"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-27 12:20:54 -0700

[diff] [blame^]

342

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

Bu Sun Kim

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

[diff] [blame]

343

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

Bu Sun Kim

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

[diff] [blame^]

344

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

Bu Sun Kim

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

[diff] [blame]

345

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

Bu Sun Kim

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

[diff] [blame^]

346

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

Bu Sun Kim

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

[diff] [blame]

347

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

348

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

349

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

Bu Sun Kim

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

[diff] [blame^]

350

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

Bu Sun Kim

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

[diff] [blame]

351

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

352

{

353

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

354

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

355

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

Sai Cheemalapati

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

[diff] [blame]

356

{

Bu Sun Kim

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

[diff] [blame]

357

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

358

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

Sai Cheemalapati

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

[diff] [blame]

359

},

360

],

Bu Sun Kim

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

[diff] [blame]

361

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

Sai Cheemalapati

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

[diff] [blame]

362

},

Bu Sun Kim

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

[diff] [blame]

363

],

Bu Sun Kim

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

[diff] [blame^]

364

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

365

},

Bu Sun Kim

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

[diff] [blame^]

366

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

367

{ # Output object for Deployments

368

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

369

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

Sai Cheemalapati

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

[diff] [blame]

370

},

Bu Sun Kim

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

[diff] [blame]

371

],

372

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

373

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

374

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

375

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

376

},

377

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

378

{

379

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

380

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

Sai Cheemalapati

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

[diff] [blame]

381

},

Bu Sun Kim

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

[diff] [blame]

382

],

383

},

384

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

385

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

386

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

387

"password": "A String",

388

"user": "A String",

389

},

390

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

391

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

392

},

393

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

Sai Cheemalapati

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

[diff] [blame]

394

},

Bu Sun Kim

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

[diff] [blame]

395

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

Bu Sun Kim

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

[diff] [blame^]

396

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

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

403

},

404

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

405

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

409

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

Sai Cheemalapati

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

[diff] [blame]

410

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

411

412

Args:

413

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

Bu Sun Kim

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

[diff] [blame]

414

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

Bu Sun Kim

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

[diff] [blame^]

415

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

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

[diff] [blame]

416

417

Returns:

418

An object of the form:

419

Bu Sun Kim

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

[diff] [blame^]

420

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

421

#

422

#

423

#

Bu Sun Kim

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

[diff] [blame^]

424

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

425

#

Bu Sun Kim

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

[diff] [blame^]

426

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

427

#

Bu Sun Kim

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

[diff] [blame^]

428

# **JSON example:**

Sai Cheemalapati

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

[diff] [blame]

429

#

Bu Sun Kim

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

[diff] [blame^]

430

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

431

#

Bu Sun Kim

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

[diff] [blame^]

432

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

433

#

Bu Sun Kim

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

[diff] [blame^]

434

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

435

#

Bu Sun Kim

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

[diff] [blame^]

436

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

Bu Sun Kim

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

[diff] [blame]

437

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

Sai Cheemalapati

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

[diff] [blame]

438

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

Sai Cheemalapati

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

[diff] [blame]

439

#

Bu Sun Kim

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

[diff] [blame]

440

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

Sai Cheemalapati

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

[diff] [blame]

441

#

442

# Example Policy with multiple AuditConfigs:

443

#

Bu Sun Kim

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

[diff] [blame^]

444

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

Sai Cheemalapati

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

[diff] [blame]

445

#

Bu Sun Kim

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

[diff] [blame^]

446

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame]

447

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

Sai Cheemalapati

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

[diff] [blame]

448

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

449

#

Bu Sun Kim

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

[diff] [blame^]

450

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

Sai Cheemalapati

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

[diff] [blame]

451

#

Bu Sun Kim

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

[diff] [blame^]

452

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

Bu Sun Kim

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

[diff] [blame]

453

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

454

"A String",

Sai Cheemalapati

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

[diff] [blame]

455

],

Bu Sun Kim

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

[diff] [blame^]

456

"ignoreChildExemptions": True or False,

Bu Sun Kim

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

[diff] [blame]

457

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

Sai Cheemalapati

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

[diff] [blame]

458

},

459

],

Bu Sun Kim

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

[diff] [blame]

"exemptedMembers": [

"A String",

],

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

Sai Cheemalapati

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

[diff] [blame]

464

},

465

],

Bu Sun Kim

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

[diff] [blame^]

466

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

467

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

Bu Sun Kim

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

[diff] [blame^]

468

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

469

#

Bu Sun Kim

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

[diff] [blame^]

470

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

471

#

472

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

473

#

474

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

475

#

476

# Example (Comparison):

477

#

478

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

479

#

480

# Example (Equality):

481

#

482

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

487

#

488

# Example (Data Manipulation):

489

#

490

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

491

#

492

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

493

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

494

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

495

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

496

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

Bu Sun Kim

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

[diff] [blame]

497

},

498

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

499

#

500

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

501

#

502

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

503

#

Bu Sun Kim

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

[diff] [blame^]

504

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

509

#

510

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

511

#

Bu Sun Kim

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

[diff] [blame^]

512

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

513

#

514

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

515

#

516

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

517

#

518

#

Bu Sun Kim

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

[diff] [blame^]

519

#

520

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

521

"A String",

Sai Cheemalapati

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

[diff] [blame]

522

],

Bu Sun Kim

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

[diff] [blame]

523

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

Sai Cheemalapati

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

[diff] [blame]

524

},

525

],

Bu Sun Kim

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

[diff] [blame]

526

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

527

#

Bu Sun Kim

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

[diff] [blame^]

528

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

Bu Sun Kim

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

[diff] [blame]

529

"iamOwned": True or False,

530

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

531

{ # A rule to be applied in a Policy.

532

"action": "A String", # Required

533

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

534

{ # A condition to be met.

535

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

536

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

537

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

538

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

Bu Sun Kim

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

[diff] [blame^]

539

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

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

545

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

546

"A String",

547

],

548

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

549

{ # Specifies what kind of log the caller must write

550

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

551

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

552

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

553

},

554

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

555

},

556

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

557

#

558

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

559

#

560

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

561

#

562

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

563

#

Bu Sun Kim

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

[diff] [blame^]

564

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

565

"customFields": [ # Custom fields.

566

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

567

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

568

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

569

},

570

],

Bu Sun Kim

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

[diff] [blame]

571

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

572

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

573

},

574

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

Bu Sun Kim

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

[diff] [blame^]

575

"logMode": "A String",

Bu Sun Kim

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

[diff] [blame]

},

},

],

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

580

"A String",

581

],

582

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

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame^]

587

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

588

#

589

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

590

#

591

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

592

#

593

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

594

#

595

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

596

#

597

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

598

#

599

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

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

604

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

605

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

606

607

Args:

608

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

Dan O'Meara

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

[diff] [blame]

609

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

610

The object takes the form of:

611

612

{

Bu Sun Kim

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

[diff] [blame]

613

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

614

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

615

"password": "A String",

616

"user": "A String",

Bu Sun Kim

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

[diff] [blame]

617

},

Bu Sun Kim

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

[diff] [blame]

618

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

619

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

620

},

621

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

622

},

623

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

Bu Sun Kim

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

[diff] [blame^]

624

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

Bu Sun Kim

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

[diff] [blame]

625

#

Bu Sun Kim

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

[diff] [blame^]

626

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

627

"id": "A String",

628

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

Bu Sun Kim

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

[diff] [blame^]

629

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Bu Sun Kim

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

[diff] [blame^]

635

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

636

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

637

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

638

#

639

# Google Compute Engine has three Operation resources:

640

#

641

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

642

#

643

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

644

#

645

# Operations can be global, regional or zonal.

646

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

647

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

648

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

649

#

650

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

Bu Sun Kim

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

[diff] [blame]

651

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

652

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

653

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

654

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

655

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

656

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

Sai Cheemalapati

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

[diff] [blame]

657

{

Bu Sun Kim

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

[diff] [blame]

658

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

659

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

660

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

Sai Cheemalapati

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

[diff] [blame]

661

},

662

],

Sai Cheemalapati

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

[diff] [blame]

663

},

Bu Sun Kim

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

[diff] [blame^]

664

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

665

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

666

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

667

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

Bu Sun Kim

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

[diff] [blame^]

668

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

669

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

670

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

Bu Sun Kim

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

[diff] [blame]

671

"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-27 12:20:54 -0700

[diff] [blame^]

672

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

Bu Sun Kim

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

[diff] [blame]

673

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

Bu Sun Kim

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

[diff] [blame^]

674

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

Bu Sun Kim

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

[diff] [blame]

675

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

Bu Sun Kim

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

[diff] [blame^]

676

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

Bu Sun Kim

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

[diff] [blame]

677

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

678

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

679

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

Bu Sun Kim

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

[diff] [blame^]

680

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

Bu Sun Kim

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

[diff] [blame]

681

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

682

{

683

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

684

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

685

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

Sai Cheemalapati

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

[diff] [blame]

686

{

Bu Sun Kim

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

[diff] [blame]

687

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

688

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

Sai Cheemalapati

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

[diff] [blame]

689

},

690

],

Bu Sun Kim

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

[diff] [blame]

691

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

Sai Cheemalapati

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

[diff] [blame]

692

},

Bu Sun Kim

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

[diff] [blame]

693

],

Bu Sun Kim

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

[diff] [blame^]

694

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

695

},

Bu Sun Kim

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

[diff] [blame^]

696

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

697

{ # Output object for Deployments

698

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

699

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

Sai Cheemalapati

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

[diff] [blame]

700

},

Bu Sun Kim

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

[diff] [blame]

701

],

702

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

703

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

704

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

705

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

706

},

707

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

708

{

709

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

710

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

Sai Cheemalapati

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

[diff] [blame]

711

},

Bu Sun Kim

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

[diff] [blame]

712

],

713

},

714

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

715

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

716

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

717

"password": "A String",

718

"user": "A String",

719

},

720

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

721

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

722

},

723

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

Sai Cheemalapati

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

[diff] [blame]

724

},

Bu Sun Kim

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

[diff] [blame]

725

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

Bu Sun Kim

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

[diff] [blame^]

726

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

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

733

},

734

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

735

}

Sai Cheemalapati

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

[diff] [blame]

736

Bu Sun Kim

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

[diff] [blame]

737

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

742

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]

743

744

Returns:

745

An object of the form:

746

Bu Sun Kim

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

[diff] [blame^]

747

{ # Represents an Operation resource.

748

#

749

# Google Compute Engine has three Operation resources:

750

#

751

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

752

#

753

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

754

#

755

# Operations can be global, regional or zonal.

756

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

757

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

758

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

759

#

760

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

Bu Sun Kim

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

[diff] [blame]

761

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

762

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

763

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

764

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

765

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

766

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

Sai Cheemalapati

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

[diff] [blame]

767

{

Bu Sun Kim

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

[diff] [blame]

768

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

769

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

770

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

Sai Cheemalapati

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

[diff] [blame]

771

},

772

],

773

},

Bu Sun Kim

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

[diff] [blame^]

774

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

775

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

776

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

777

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

Bu Sun Kim

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

[diff] [blame^]

778

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

779

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

780

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

Bu Sun Kim

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

[diff] [blame]

781

"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-27 12:20:54 -0700

[diff] [blame^]

782

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

Bu Sun Kim

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

[diff] [blame]

783

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

Bu Sun Kim

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

[diff] [blame^]

784

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

Bu Sun Kim

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

[diff] [blame]

785

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

Bu Sun Kim

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

[diff] [blame^]

786

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

Bu Sun Kim

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

[diff] [blame]

787

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

788

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

789

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

Bu Sun Kim

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

[diff] [blame^]

790

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

Bu Sun Kim

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

[diff] [blame]

791

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

792

{

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.

794

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

795

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

796

{

797

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

798

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

799

},

800

],

801

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

802

},

803

],

Bu Sun Kim

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

[diff] [blame^]

804

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

809

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

Sai Cheemalapati

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

[diff] [blame]

810

<pre>Lists all deployments for a given project.

811

812

Args:

813

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

Bu Sun Kim

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

[diff] [blame^]

814

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]

815

Bu Sun Kim

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

[diff] [blame^]

816

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]

817

Bu Sun Kim

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

[diff] [blame^]

818

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]

819

Bu Sun Kim

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

[diff] [blame^]

820

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

821

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Bu Sun Kim

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

[diff] [blame]

822

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

823

Bu Sun Kim

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

[diff] [blame^]

824

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]

825

Bu Sun Kim

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

[diff] [blame^]

826

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

827

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.

828

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

Sai Cheemalapati

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

[diff] [blame]

829

830

Returns:

831

An object of the form:

832

833

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

834

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

Sai Cheemalapati

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

[diff] [blame]

835

{

Bu Sun Kim

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

[diff] [blame]

836

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

837

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

838

"password": "A String",

839

"user": "A String",

Bu Sun Kim

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

[diff] [blame]

840

},

Bu Sun Kim

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

[diff] [blame]

841

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

842

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

843

},

844

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

845

},

846

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

Bu Sun Kim

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

[diff] [blame^]

847

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

Bu Sun Kim

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

[diff] [blame]

848

#

Bu Sun Kim

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

[diff] [blame^]

849

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

850

"id": "A String",

851

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

Bu Sun Kim

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

[diff] [blame^]

852

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Bu Sun Kim

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

[diff] [blame^]

858

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

859

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

860

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

861

#

862

# Google Compute Engine has three Operation resources:

863

#

864

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

865

#

866

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

867

#

868

# Operations can be global, regional or zonal.

869

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

870

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

871

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

872

#

873

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

Bu Sun Kim

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

[diff] [blame]

874

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

875

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

876

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

877

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

878

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

879

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

Sai Cheemalapati

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

[diff] [blame]

880

{

Bu Sun Kim

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

[diff] [blame]

881

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

882

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

883

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

Sai Cheemalapati

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

[diff] [blame]

884

},

885

],

Sai Cheemalapati

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

[diff] [blame]

886

},

Bu Sun Kim

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

[diff] [blame^]

887

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

888

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

889

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

890

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

Bu Sun Kim

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

[diff] [blame^]

891

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

892

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

893

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

Bu Sun Kim

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

[diff] [blame]

894

"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-27 12:20:54 -0700

[diff] [blame^]

895

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

Bu Sun Kim

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

[diff] [blame]

896

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

Bu Sun Kim

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

[diff] [blame^]

897

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

Bu Sun Kim

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

[diff] [blame]

898

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

Bu Sun Kim

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

[diff] [blame^]

899

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

Bu Sun Kim

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

[diff] [blame]

900

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

901

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

902

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

Bu Sun Kim

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

[diff] [blame^]

903

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

Bu Sun Kim

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

[diff] [blame]

904

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

905

{

906

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

907

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

908

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

Sai Cheemalapati

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

[diff] [blame]

909

{

Bu Sun Kim

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

[diff] [blame]

910

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

911

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

Sai Cheemalapati

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

[diff] [blame]

912

},

913

],

Bu Sun Kim

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

[diff] [blame]

914

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

Sai Cheemalapati

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

[diff] [blame]

915

},

Bu Sun Kim

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

[diff] [blame]

916

],

Bu Sun Kim

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

[diff] [blame^]

917

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

Sai Cheemalapati

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

[diff] [blame]

918

},

Bu Sun Kim

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

[diff] [blame^]

919

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

920

{ # Output object for Deployments

921

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

922

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

Bu Sun Kim

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

[diff] [blame]

923

},

924

],

925

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

926

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

927

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

928

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

929

},

930

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

931

{

932

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

933

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

},

],

},

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

938

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

939

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

940

"password": "A String",

941

"user": "A String",

942

},

943

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

944

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

945

},

946

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

947

},

948

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

Bu Sun Kim

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

[diff] [blame^]

949

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

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

956

},

957

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

958

},

Sai Cheemalapati

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

[diff] [blame]

959

],

Bu Sun Kim

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

[diff] [blame]

960

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

966

<pre>Retrieves the next page of results.

967

968

Args:

969

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

970

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

971

972

Returns:

Bu Sun Kim

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

[diff] [blame]

973

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

Sai Cheemalapati

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

[diff] [blame]

974

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

979

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

Bu Sun Kim

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

[diff] [blame^]

980

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

981

982

Args:

983

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

984

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

Dan O'Meara

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

[diff] [blame]

985

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

986

The object takes the form of:

987

988

{

Bu Sun Kim

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

[diff] [blame]

989

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

990

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

991

"password": "A String",

992

"user": "A String",

Bu Sun Kim

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

[diff] [blame]

993

},

Bu Sun Kim

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

[diff] [blame]

994

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

995

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

996

},

997

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

998

},

999

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

Bu Sun Kim

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

[diff] [blame^]

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

#

Bu Sun Kim

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

[diff] [blame^]

1002

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

1003

"id": "A String",

1004

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

Bu Sun Kim

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

[diff] [blame^]

1005

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

Bu Sun Kim

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

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Bu Sun Kim

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

[diff] [blame^]

1011

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

1012

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

1013

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

1014

#

1015

# Google Compute Engine has three Operation resources:

1016

#

1017

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

1018

#

1019

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

1020

#

1021

# Operations can be global, regional or zonal.

1022

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

1023

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

1024

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

1025

#

1026

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

Bu Sun Kim

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

[diff] [blame]

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

Sai Cheemalapati

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

[diff] [blame]

1033

{

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

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

1036

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

Sai Cheemalapati

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

[diff] [blame]

1037

},

1038

],

Sai Cheemalapati

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

[diff] [blame]

1039

},

Bu Sun Kim

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

[diff] [blame^]

1040

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

1041

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

1042

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

1043

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

Bu Sun Kim

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

[diff] [blame^]

1044

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

1045

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

1046

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

Bu Sun Kim

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

[diff] [blame]

1047

"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-27 12:20:54 -0700

[diff] [blame^]

1048

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

Bu Sun Kim

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

[diff] [blame]

1049

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

Bu Sun Kim

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

[diff] [blame^]

1050

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

Bu Sun Kim

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

[diff] [blame]

1051

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

Bu Sun Kim

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

[diff] [blame^]

1052

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

Bu Sun Kim

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

[diff] [blame]

1053

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

1054

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

1055

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1056

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1057

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1058

{

1059

"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.

1060

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1061

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1062

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1063

"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).

1064

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1065

},

1066

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1067

"message": "A String", # [Output Only] A human-readable description of the warning code.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1068

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1069

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1070

"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]

1071

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1072

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

1073

{ # Output object for Deployments

1074

"key": "A String", # Key of the output

1075

"value": "A String", # Value of the label

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1076

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1077

],

1078

"selfLink": "A String", # Output only. Server defined URL for the resource.

1079

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

1080

"config": { # The configuration to use for this deployment.

1081

"content": "A String", # The contents of the file.

1082

},

1083

"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.

1084

{

1085

"content": "A String", # The contents of the file.

1086

"name": "A String", # The name of the file.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1087

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1088

],

1089

},

1090

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

1091

"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.

1092

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1093

"password": "A String",

1094

"user": "A String",

1095

},

1096

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1097

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1098

},

1099

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1100

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1101

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1102

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

1109

},

1110

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

1111

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1112

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1113

createPolicy: string, Sets the policy to use for creating new resources.

1114

Allowed values

1115

ACQUIRE -

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1116

CREATE -

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1117

CREATE_OR_ACQUIRE -

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1118

deletePolicy: string, Sets the policy to use for deleting resources.

1119

Allowed values

1120

ABANDON -

1121

DELETE -

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1122

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]

1123

1124

Returns:

1125

An object of the form:

1126

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1127

{ # Represents an Operation resource.

1128

#

1129

# Google Compute Engine has three Operation resources:

1130

#

1131

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1132

#

1133

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1134

#

1135

# Operations can be global, regional or zonal.

1136

# - For global operations, use the `globalOperations` resource.

1137

# - For regional operations, use the `regionOperations` resource.

1138

# - For zonal operations, use the `zonalOperations` resource.

1139

#

1140

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1141

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1142

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1143

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1144

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1145

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1146

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1147

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1148

"code": "A String", # [Output Only] The error type identifier for this error.

1149

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1150

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1151

},

1152

],

1153

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1154

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1155

"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.

1156

"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]

1157

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1158

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1159

"name": "A String", # [Output Only] Name of the operation.

1160

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1161

"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-27 12:20:54 -0700

[diff] [blame^]

1162

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1163

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1164

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1165

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1166

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1167

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1168

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1169

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1170

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1171

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1172

{

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.

1174

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1175

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1176

{

1177

"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).

1178

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1179

},

1180

],

1181

"message": "A String", # [Output Only] A human-readable description of the warning code.

1182

},

1183

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1184

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

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]

1189

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1190

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

1191

1192

Args:

1193

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1194

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1195

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1196

The object takes the form of:

1197

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1198

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1199

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

1200

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1201

"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]

1202

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1203

# If the condition evaluates to `true`, then this binding applies to the current request.

1204

#

1205

# 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.

1206

#

1207

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1208

#

1209

# Example (Comparison):

1210

#

1211

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1212

#

1213

# Example (Equality):

1214

#

1215

# 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'"

1220

#

1221

# Example (Data Manipulation):

1222

#

1223

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1224

#

1225

# 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.

1226

"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]

1227

"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^]

1228

"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.

1229

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1230

},

1231

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

1232

#

1233

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1234

#

1235

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1236

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1237

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1242

#

1243

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1244

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1245

# * `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.

1246

#

1247

# * `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.

1248

#

1249

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1250

#

1251

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1252

#

1253

# * `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]

1254

"A String",

1255

],

1256

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1257

},

1258

],

1259

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1260

"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]

1261

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1262

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1263

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1264

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1265

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1266

# 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]

1267

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1268

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1269

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1270

# { "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]

1271

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1272

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1273

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1274

# 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]

1275

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1276

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1277

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1278

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1279

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1280

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1281

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1282

# Example Policy with multiple AuditConfigs:

1283

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1284

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1285

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1286

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1287

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1288

{ # Provides the configuration for logging a type of permissions. Example:

1289

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1290

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1291

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1292

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1293

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1294

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1295

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1296

"ignoreChildExemptions": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1297

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1298

},

1299

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1304

},

1305

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1306

"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]

1307

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1308

"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]

1309

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1310

# If the condition evaluates to `true`, then this binding applies to the current request.

1311

#

1312

# 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.

1313

#

1314

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1315

#

1316

# Example (Comparison):

1317

#

1318

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1319

#

1320

# Example (Equality):

1321

#

1322

# 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'"

1327

#

1328

# Example (Data Manipulation):

1329

#

1330

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1331

#

1332

# 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.

1333

"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]

1334

"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^]

1335

"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.

1336

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

},

1338

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1339

#

1340

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1341

#

1342

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1343

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1344

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

1349

#

1350

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1351

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1352

# * `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.

1353

#

1354

# * `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.

1355

#

1356

# * `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]

1357

#

1358

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1359

#

1360

# * `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]

1361

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1362

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1363

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1364

},

1365

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1366

"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.

1367

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1368

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

"iamOwned": True or False,

1370

"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.

1371

{ # A rule to be applied in a Policy.

1372

"action": "A String", # Required

1373

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1374

{ # A condition to be met.

1375

"iam": "A String", # Trusted attributes supplied by the IAM system.

1376

"op": "A String", # An operator to apply the subject with.

1377

"svc": "A String", # Trusted attributes discharged by the service.

1378

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1379

"values": [ # The objects of the condition.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1385

"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.

1386

"A String",

1387

],

1388

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1389

{ # Specifies what kind of log the caller must write

1390

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1391

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1392

"permissionType": "A String", # The type of the permission that was checked.

1393

},

1394

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1395

},

1396

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1397

#

1398

# 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.

1399

#

1400

# Field names correspond to IAM request parameters and field values are their respective values.

1401

#

1402

# 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.

1403

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1404

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1405

"customFields": [ # Custom fields.

1406

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1407

"name": "A String", # Name is the field name.

1408

"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.

1409

},

1410

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1411

"field": "A String", # The field value to attribute.

1412

"metric": "A String", # The metric to update.

1413

},

1414

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1415

"logMode": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1420

"A String",

1421

],

1422

"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.

1423

"A String",

1424

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1425

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1426

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1427

"version": 42, # Specifies the format of the policy.

1428

#

1429

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1430

#

1431

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1432

#

1433

# * 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

1434

#

1435

# **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.

1436

#

1437

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1438

#

1439

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1440

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1441

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

Returns:

An object of the form:

1446

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1447

{ # 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]

1448

#

1449

#

1450

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1451

# 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]

1452

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1453

# 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]

1454

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1455

# **JSON example:**

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1456

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1457

# { "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]

1458

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1459

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1460

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1461

# 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]

1462

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1463

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1464

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1465

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1466

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1467

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1468

#

1469

# Example Policy with multiple AuditConfigs:

1470

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1471

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1472

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1473

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1474

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1475

{ # Provides the configuration for logging a type of permissions. Example:

1476

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1477

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1478

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1479

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1480

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

1481

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1482

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1483

"ignoreChildExemptions": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1484

"logType": "A String", # The log type that this config enables.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1485

},

1486

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1491

},

1492

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1493

"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]

1494

{ # Associates `members` with a `role`.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1495

"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]

1496

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1497

# If the condition evaluates to `true`, then this binding applies to the current request.

1498

#

1499

# 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.

1500

#

1501

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1502

#

1503

# Example (Comparison):

1504

#

1505

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

1506

#

1507

# Example (Equality):

1508

#

1509

# 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'"

1514

#

1515

# Example (Data Manipulation):

1516

#

1517

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

1518

#

1519

# 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.

1520

"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]

1521

"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^]

1522

"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.

1523

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1524

},

1525

"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]

1526

#

1527

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

1528

#

1529

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1530

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1531

# * `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`.

1536

#

1537

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

1538

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1539

# * `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.

1540

#

1541

# * `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.

1542

#

1543

# * `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]

1544

#

1545

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1546

#

1547

# * `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]

1548

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1549

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1550

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1551

},

1552

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1553

"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.

1554

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1555

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1556

"iamOwned": True or False,

1557

"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.

1558

{ # A rule to be applied in a Policy.

1559

"action": "A String", # Required

1560

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

1561

{ # A condition to be met.

1562

"iam": "A String", # Trusted attributes supplied by the IAM system.

1563

"op": "A String", # An operator to apply the subject with.

1564

"svc": "A String", # Trusted attributes discharged by the service.

1565

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1566

"values": [ # The objects of the condition.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

1572

"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.

1573

"A String",

1574

],

1575

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

1576

{ # Specifies what kind of log the caller must write

1577

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

1578

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

1579

"permissionType": "A String", # The type of the permission that was checked.

1580

},

1581

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

1582

},

1583

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

1584

#

1585

# 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.

1586

#

1587

# Field names correspond to IAM request parameters and field values are their respective values.

1588

#

1589

# 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.

1590

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1591

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

1592

"customFields": [ # Custom fields.

1593

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

1594

"name": "A String", # Name is the field name.

1595

"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.

1596

},

1597

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1598

"field": "A String", # The field value to attribute.

1599

"metric": "A String", # The metric to update.

1600

},

1601

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1602

"logMode": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

1607

"A String",

1608

],

1609

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1614

"version": 42, # Specifies the format of the policy.

1615

#

1616

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

1617

#

1618

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

1619

#

1620

# * 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

1621

#

1622

# **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.

1623

#

1624

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

1625

#

1626

# 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]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1631

<code class="details" id="stop">stop(project, deployment, body=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1632

<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.

1633

1634

Args:

1635

project: string, The project ID for this request. (required)

1636

deployment: string, The name of the deployment for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1637

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1638

The object takes the form of:

1639

1640

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1641

"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]

1642

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1643

# 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:

1649

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1650

{ # Represents an Operation resource.

1651

#

1652

# Google Compute Engine has three Operation resources:

1653

#

1654

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1655

#

1656

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1657

#

1658

# Operations can be global, regional or zonal.

1659

# - For global operations, use the `globalOperations` resource.

1660

# - For regional operations, use the `regionOperations` resource.

1661

# - For zonal operations, use the `zonalOperations` resource.

1662

#

1663

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1664

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1665

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1666

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1667

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1668

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1669

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1670

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1671

"code": "A String", # [Output Only] The error type identifier for this error.

1672

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1673

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1674

},

1675

],

1676

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1677

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1678

"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.

1679

"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]

1680

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1681

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1682

"name": "A String", # [Output Only] Name of the operation.

1683

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1684

"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-27 12:20:54 -0700

[diff] [blame^]

1685

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1686

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1687

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1688

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1689

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1690

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1691

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1692

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1693

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1694

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1695

{

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.

1697

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1698

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1699

{

1700

"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).

1701

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1702

},

1703

],

1704

"message": "A String", # [Output Only] A human-readable description of the warning code.

1705

},

1706

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1707

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

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]

1712

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1713

<pre>Returns permissions that a caller has on the specified resource.

1714

1715

Args:

1716

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1717

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1718

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1719

The object takes the form of:

1720

1721

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1722

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1723

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

],

}

Returns:

An object of the form:

1730

1731

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1732

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1733

"A String",

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1739

<code class="details" id="update">update(project, deployment, body=None, createPolicy=None, deletePolicy=None, preview=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1740

<pre>Updates a deployment and all of the resources described by the deployment manifest.

1741

1742

Args:

1743

project: string, The project ID for this request. (required)

1744

deployment: string, The name of the deployment for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1745

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1746

The object takes the form of:

1747

1748

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1749

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # User provided default credential for the deployment.

1750

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1751

"password": "A String",

1752

"user": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1753

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1754

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1755

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1756

},

1757

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

1758

},

1759

"description": "A String", # An optional user-provided description of the deployment.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1760

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1761

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1762

# 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]

1763

"id": "A String",

1764

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1765

"labels": [ # Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1771

"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.

1772

"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.

1773

"operation": { # Represents an Operation resource. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

1774

#

1775

# Google Compute Engine has three Operation resources:

1776

#

1777

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1778

#

1779

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1780

#

1781

# Operations can be global, regional or zonal.

1782

# - For global operations, use the `globalOperations` resource.

1783

# - For regional operations, use the `regionOperations` resource.

1784

# - For zonal operations, use the `zonalOperations` resource.

1785

#

1786

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1787

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1788

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1789

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1790

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1791

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1792

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1793

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1794

"code": "A String", # [Output Only] The error type identifier for this error.

1795

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1796

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1797

},

1798

],

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1799

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1800

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1801

"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.

1802

"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]

1803

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1804

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1805

"name": "A String", # [Output Only] Name of the operation.

1806

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1807

"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-27 12:20:54 -0700

[diff] [blame^]

1808

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1809

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1810

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1811

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1812

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1813

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1814

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1815

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1816

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1817

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1818

{

1819

"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.

1820

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1821

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1822

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1823

"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).

1824

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1825

},

1826

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1827

"message": "A String", # [Output Only] A human-readable description of the warning code.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1828

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1829

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1830

"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]

1831

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1832

"outputs": [ # Output only. List of outputs from the last manifest that deployed successfully.

1833

{ # Output object for Deployments

1834

"key": "A String", # Key of the output

1835

"value": "A String", # Value of the label

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1836

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1837

],

1838

"selfLink": "A String", # Output only. Server defined URL for the resource.

1839

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

1840

"config": { # The configuration to use for this deployment.

1841

"content": "A String", # The contents of the file.

1842

},

1843

"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.

1844

{

1845

"content": "A String", # The contents of the file.

1846

"name": "A String", # The name of the file.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1847

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1848

],

1849

},

1850

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

1851

"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.

1852

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1853

"password": "A String",

1854

"user": "A String",

1855

},

1856

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1857

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1858

},

1859

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1860

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1861

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1862

"labels": [ # Output only. Map of labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

{

"key": "A String",

"value": "A String",

},

],

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

1869

},

1870

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

1871

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1872

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1873

createPolicy: string, Sets the policy to use for creating new resources.

1874

Allowed values

1875

ACQUIRE -

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1876

CREATE -

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1877

CREATE_OR_ACQUIRE -

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

deletePolicy: string, Sets the policy to use for deleting resources.

1879

Allowed values

1880

ABANDON -

1881

DELETE -

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1882

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]

1883

1884

Returns:

1885

An object of the form:

1886

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1887

{ # Represents an Operation resource.

1888

#

1889

# Google Compute Engine has three Operation resources:

1890

#

1891

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1892

#

1893

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1894

#

1895

# Operations can be global, regional or zonal.

1896

# - For global operations, use the `globalOperations` resource.

1897

# - For regional operations, use the `regionOperations` resource.

1898

# - For zonal operations, use the `zonalOperations` resource.

1899

#

1900

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1901

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1902

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1903

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1904

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1905

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1906

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1907

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1908

"code": "A String", # [Output Only] The error type identifier for this error.

1909

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1910

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1911

},

1912

],

1913

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1914

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1915

"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.

1916

"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]

1917

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1918

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1919

"name": "A String", # [Output Only] Name of the operation.

1920

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1921

"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-27 12:20:54 -0700

[diff] [blame^]

1922

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1923

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1924

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1925

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1926

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1927

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1928

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1929

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1930

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

Bu Sun Kim