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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

78

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

Sai Cheemalapati

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

[diff] [blame]

79

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

80

Dmitry Frenkel

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

[diff] [blame]

81

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

82

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

83

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

84

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

Sai Cheemalapati

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

[diff] [blame]

85

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

86

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

87

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

Sai Cheemalapati

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

[diff] [blame]

88

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

89

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

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

92

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

93

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

Sai Cheemalapati

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

[diff] [blame]

94

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

95

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

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

98

99

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

100

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

101

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

Sai Cheemalapati

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

[diff] [blame]

104

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

105

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

Sai Cheemalapati

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

[diff] [blame]

106

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

107

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

108

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

Sai Cheemalapati

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

[diff] [blame]

109

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

110

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

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

116

<h3>Method Details</h3>

117

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

118

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

Sai Cheemalapati

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

[diff] [blame]

119

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

120

121

Args:

122

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

123

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

Dan O'Meara

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

[diff] [blame]

124

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

125

The object takes the form of:

126

127

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

128

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

129

}

130

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

131

x__xgafv: string, V1 error format.

132

Allowed values

133

1 - v1 error format

134

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

135

136

Returns:

137

An object of the form:

138

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

139

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

140

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

Dmitry Frenkel

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

[diff] [blame]

141

"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-11-16 11:05:03 -0700

[diff] [blame]

142

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

143

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

144

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

145

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

Bu Sun Kim

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

[diff] [blame]

146

"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-11-16 11:05:03 -0700

[diff] [blame]

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

150

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

151

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

152

{

153

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

154

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

155

},

156

],

Dmitry Frenkel

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

[diff] [blame]

157

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

158

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

Bu Sun Kim

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

[diff] [blame]

159

},

160

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

161

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

162

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

Dmitry Frenkel

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

[diff] [blame]

163

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

164

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

165

{

Dmitry Frenkel

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

[diff] [blame]

166

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

167

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

Dmitry Frenkel

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

[diff] [blame]

168

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

169

},

170

],

171

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

172

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

173

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

Dmitry Frenkel

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

[diff] [blame]

174

"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-11-16 11:05:03 -0700

[diff] [blame]

175

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

176

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

177

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

178

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

179

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

180

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

181

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

186

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

187

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

191

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

Sai Cheemalapati

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

[diff] [blame]

192

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

193

194

Args:

195

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

196

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

197

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

198

Allowed values

Sai Cheemalapati

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

[diff] [blame]

199

DELETE -

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

200

ABANDON -

201

x__xgafv: string, V1 error format.

202

Allowed values

203

1 - v1 error format

204

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

205

206

Returns:

207

An object of the form:

208

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

209

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

210

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

Dmitry Frenkel

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

[diff] [blame]

211

"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-11-16 11:05:03 -0700

[diff] [blame]

212

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

213

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

214

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

215

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

Bu Sun Kim

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

[diff] [blame]

216

"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-11-16 11:05:03 -0700

[diff] [blame]

217

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

218

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

Bu Sun Kim

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

[diff] [blame]

219

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

220

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

221

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

222

{

223

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

224

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

225

},

226

],

Dmitry Frenkel

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

[diff] [blame]

227

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

},

230

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

231

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

232

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

Dmitry Frenkel

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

[diff] [blame]

233

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

234

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

235

{

Dmitry Frenkel

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

[diff] [blame]

236

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

237

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

Dmitry Frenkel

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

[diff] [blame]

238

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

239

},

240

],

241

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

242

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

243

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

Dmitry Frenkel

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

[diff] [blame]

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-11-16 11:05:03 -0700

[diff] [blame]

245

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

246

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

247

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

248

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

249

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

250

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

251

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

256

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

Sai Cheemalapati

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

[diff] [blame]

257

<pre>Gets information about a specific deployment.

258

259

Args:

260

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

261

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

262

x__xgafv: string, V1 error format.

263

Allowed values

264

1 - v1 error format

265

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

266

267

Returns:

268

An object of the form:

269

270

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

271

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

272

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

273

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

274

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

275

},

276

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

277

"password": "A String",

"user": "A String",

},

},

"labels": [ # Map of One Platform 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])?)?`.

282

{ # Label object for Deployments

283

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

284

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

Dmitry Frenkel

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

[diff] [blame]

285

},

286

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

287

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

288

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

Dmitry Frenkel

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

[diff] [blame]

289

"id": "A String",

Dmitry Frenkel

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

[diff] [blame]

290

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

291

{ # Output object for Deployments

292

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

293

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

294

},

295

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

296

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

297

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

298

"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

299

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

Dmitry Frenkel

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

[diff] [blame]

300

"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-11-16 11:05:03 -0700

[diff] [blame]

301

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

302

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

303

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

304

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

Dmitry Frenkel

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

[diff] [blame]

305

"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-11-16 11:05:03 -0700

[diff] [blame]

306

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

307

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

Dmitry Frenkel

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

[diff] [blame]

308

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

309

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

310

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dmitry Frenkel

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

[diff] [blame]

311

{

312

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

313

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

314

},

315

],

316

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

317

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

Dmitry Frenkel

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

[diff] [blame]

318

},

319

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

320

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

321

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

Dmitry Frenkel

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

[diff] [blame]

322

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

323

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

Sai Cheemalapati

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

[diff] [blame]

324

{

Dmitry Frenkel

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

[diff] [blame]

325

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

326

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

Dmitry Frenkel

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

[diff] [blame]

327

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

Sai Cheemalapati

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

[diff] [blame]

328

},

329

],

330

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

331

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

332

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

Dmitry Frenkel

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

[diff] [blame]

333

"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-11-16 11:05:03 -0700

[diff] [blame]

334

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

335

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

336

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

337

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

338

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

339

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

340

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

Sai Cheemalapati

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

[diff] [blame]

341

},

Dmitry Frenkel

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

[diff] [blame]

342

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

343

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

Dmitry Frenkel

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

[diff] [blame]

344

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

345

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

346

{

Dmitry Frenkel

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

[diff] [blame]

347

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

348

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

Dmitry Frenkel

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

[diff] [blame]

349

},

350

],

351

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

352

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

Bu Sun Kim

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

[diff] [blame]

353

},

Dmitry Frenkel

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

[diff] [blame]

354

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

355

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

356

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

357

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

358

"labels": [ # Map of One Platform 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])?)?`.

359

{ # Label object for DeploymentUpdate

360

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

361

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

362

},

363

],

364

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

365

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

366

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

367

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

368

},

369

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

370

"password": "A String",

"user": "A String",

},

},

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

375

},

Dmitry Frenkel

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

[diff] [blame]

376

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

380

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

Sai Cheemalapati

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

[diff] [blame]

381

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

382

383

Args:

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

Bu Sun Kim

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

[diff] [blame]

386

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

387

x__xgafv: string, V1 error format.

388

Allowed values

389

1 - v1 error format

390

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

391

392

Returns:

393

An object of the form:

394

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

395

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

396

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. 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-27 12:20:54 -0700

[diff] [blame]

397

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

398

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

Dmitry Frenkel

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

[diff] [blame]

399

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

400

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

401

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

402

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

403

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

404

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

405

},

406

"bindingId": "A String",

407

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Dmitry Frenkel

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

[diff] [blame]

408

"A String",

409

],

Sai Cheemalapati

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

[diff] [blame]

410

},

411

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

412

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

Dmitry Frenkel

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

[diff] [blame]

413

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

414

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Dmitry Frenkel

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

[diff] [blame]

415

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

416

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

417

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

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

[diff] [blame]

418

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

419

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

424

},

425

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

430

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

Sai Cheemalapati

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

[diff] [blame]

431

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

432

433

Args:

434

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

Dan O'Meara

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

[diff] [blame]

435

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

436

The object takes the form of:

437

438

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

439

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

440

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

441

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

442

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

443

},

444

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

445

"password": "A String",

"user": "A String",

},

},

"labels": [ # Map of One Platform 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])?)?`.

450

{ # Label object for Deployments

451

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

452

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

Dmitry Frenkel

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

[diff] [blame]

453

},

454

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

455

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

456

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

Dmitry Frenkel

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

[diff] [blame]

457

"id": "A String",

Dmitry Frenkel

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

[diff] [blame]

458

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

459

{ # Output object for Deployments

460

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

461

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

462

},

463

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

464

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

465

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

466

"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

467

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

Dmitry Frenkel

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

[diff] [blame]

468

"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-11-16 11:05:03 -0700

[diff] [blame]

469

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

470

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

471

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

472

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

Dmitry Frenkel

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

[diff] [blame]

473

"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-11-16 11:05:03 -0700

[diff] [blame]

474

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

475

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

Dmitry Frenkel

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

[diff] [blame]

476

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

477

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

478

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dmitry Frenkel

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

[diff] [blame]

479

{

480

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

481

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

482

},

483

],

484

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

485

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

Dmitry Frenkel

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

[diff] [blame]

486

},

487

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

488

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

489

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

Dmitry Frenkel

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

[diff] [blame]

490

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

491

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

Sai Cheemalapati

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

[diff] [blame]

492

{

Dmitry Frenkel

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

[diff] [blame]

493

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

494

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

Dmitry Frenkel

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

[diff] [blame]

495

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

Sai Cheemalapati

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

[diff] [blame]

496

},

497

],

498

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

499

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

500

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

Dmitry Frenkel

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

[diff] [blame]

501

"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-11-16 11:05:03 -0700

[diff] [blame]

502

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

503

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

504

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

505

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

506

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

507

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

508

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

Sai Cheemalapati

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

[diff] [blame]

509

},

Dmitry Frenkel

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

[diff] [blame]

510

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

511

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

Dmitry Frenkel

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

[diff] [blame]

512

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

513

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

514

{

Dmitry Frenkel

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

[diff] [blame]

515

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

516

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

Dmitry Frenkel

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

[diff] [blame]

517

},

518

],

519

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

520

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

Bu Sun Kim

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

[diff] [blame]

521

},

Dmitry Frenkel

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

[diff] [blame]

522

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

523

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

524

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

525

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

526

"labels": [ # Map of One Platform 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])?)?`.

527

{ # Label object for DeploymentUpdate

528

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

529

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

530

},

531

],

532

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

533

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

534

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

535

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

536

},

537

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

538

"password": "A String",

"user": "A String",

},

},

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

543

},

Dmitry Frenkel

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

[diff] [blame]

544

}

Sai Cheemalapati

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

[diff] [blame]

545

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

546

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

Bu Sun Kim

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

[diff] [blame]

547

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

548

Allowed values

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

549

CREATE_OR_ACQUIRE -

Bu Sun Kim

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

[diff] [blame]

550

ACQUIRE -

551

CREATE -

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

552

x__xgafv: string, V1 error format.

553

Allowed values

554

1 - v1 error format

555

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

556

557

Returns:

558

An object of the form:

559

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

560

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

561

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

Dmitry Frenkel

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

[diff] [blame]

562

"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-11-16 11:05:03 -0700

[diff] [blame]

563

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

564

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

565

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

566

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

Bu Sun Kim

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

[diff] [blame]

567

"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-11-16 11:05:03 -0700

[diff] [blame]

568

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

569

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

Bu Sun Kim

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

[diff] [blame]

570

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

571

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

572

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

573

{

574

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

575

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

576

},

577

],

Dmitry Frenkel

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

[diff] [blame]

578

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

579

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

Bu Sun Kim

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

[diff] [blame]

580

},

581

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

582

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

583

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

Dmitry Frenkel

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

[diff] [blame]

584

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

585

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

586

{

Dmitry Frenkel

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

[diff] [blame]

587

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

588

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

Dmitry Frenkel

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

[diff] [blame]

589

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

590

},

591

],

592

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

593

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

594

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

Dmitry Frenkel

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

[diff] [blame]

595

"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-11-16 11:05:03 -0700

[diff] [blame]

596

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

597

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

598

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

599

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

600

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

601

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

602

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

607

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

Sai Cheemalapati

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

[diff] [blame]

608

<pre>Lists all deployments for a given project.

609

610

Args:

611

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

Dmitry Frenkel

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

[diff] [blame]

612

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.

Dmitry Frenkel

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

[diff] [blame]

613

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-11-16 11:05:03 -0700

[diff] [blame]

614

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

615

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.

616

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```

617

x__xgafv: string, V1 error format.

618

Allowed values

619

1 - v1 error format

620

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

621

622

Returns:

623

An object of the form:

624

625

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

626

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

Sai Cheemalapati

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

[diff] [blame]

627

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

628

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

629

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

630

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

631

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

632

},

633

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

634

"password": "A String",

"user": "A String",

},

},

"labels": [ # Map of One Platform 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])?)?`.

639

{ # Label object for Deployments

640

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

641

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

Dmitry Frenkel

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

[diff] [blame]

642

},

643

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

644

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

645

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

Dmitry Frenkel

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

[diff] [blame]

646

"id": "A String",

Dmitry Frenkel

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

[diff] [blame]

647

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

648

{ # Output object for Deployments

649

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

650

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

651

},

652

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

653

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

654

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

655

"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

656

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

Dmitry Frenkel

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

[diff] [blame]

657

"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-11-16 11:05:03 -0700

[diff] [blame]

658

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

659

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

660

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

661

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

Dmitry Frenkel

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

[diff] [blame]

662

"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-11-16 11:05:03 -0700

[diff] [blame]

663

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

664

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

Dmitry Frenkel

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

[diff] [blame]

665

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

666

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

667

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dmitry Frenkel

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

[diff] [blame]

668

{

669

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

670

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

671

},

672

],

673

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

674

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

Dmitry Frenkel

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

[diff] [blame]

675

},

676

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

677

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

678

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

Dmitry Frenkel

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

[diff] [blame]

679

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

680

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

Sai Cheemalapati

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

[diff] [blame]

681

{

Dmitry Frenkel

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

[diff] [blame]

682

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

683

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

Dmitry Frenkel

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

[diff] [blame]

684

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

Sai Cheemalapati

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

[diff] [blame]

685

},

686

],

687

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

688

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

689

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

Dmitry Frenkel

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

[diff] [blame]

690

"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-11-16 11:05:03 -0700

[diff] [blame]

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

},

Dmitry Frenkel

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

[diff] [blame]

699

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

700

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

Dmitry Frenkel

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

[diff] [blame]

701

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

702

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

703

{

Dmitry Frenkel

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

[diff] [blame]

704

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

705

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

Dmitry Frenkel

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

[diff] [blame]

706

},

707

],

708

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

709

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

Bu Sun Kim

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

[diff] [blame]

710

},

Dmitry Frenkel

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

[diff] [blame]

711

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

712

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

713

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

714

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

715

"labels": [ # Map of One Platform 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])?)?`.

716

{ # Label object for DeploymentUpdate

717

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

718

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

719

},

720

],

721

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

722

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

723

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

724

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

725

},

726

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

727

"password": "A String",

"user": "A String",

},

},

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

732

},

Bu Sun Kim

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

[diff] [blame]

733

},

Sai Cheemalapati

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

[diff] [blame]

734

],

Bu Sun Kim

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

[diff] [blame]

735

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

741

<pre>Retrieves the next page of results.

742

743

Args:

744

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

745

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

746

747

Returns:

Bu Sun Kim

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

[diff] [blame]

748

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

Sai Cheemalapati

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

[diff] [blame]

749

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

</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

754

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

Bu Sun Kim

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

[diff] [blame]

755

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

756

757

Args:

758

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

759

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

Dan O'Meara

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

[diff] [blame]

760

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

761

The object takes the form of:

762

763

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

764

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

765

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

766

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

767

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

768

},

769

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

770

"password": "A String",

"user": "A String",

},

},

"labels": [ # Map of One Platform 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])?)?`.

775

{ # Label object for Deployments

776

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

777

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

Dmitry Frenkel

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

[diff] [blame]

778

},

779

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

780

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

781

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

Dmitry Frenkel

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

[diff] [blame]

782

"id": "A String",

Dmitry Frenkel

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

[diff] [blame]

783

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

784

{ # Output object for Deployments

785

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

786

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

787

},

788

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

789

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

790

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

791

"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

792

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

Dmitry Frenkel

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

[diff] [blame]

793

"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-11-16 11:05:03 -0700

[diff] [blame]

794

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

795

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

796

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

797

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

Dmitry Frenkel

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

[diff] [blame]

798

"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-11-16 11:05:03 -0700

[diff] [blame]

799

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

800

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

Dmitry Frenkel

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

[diff] [blame]

801

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

802

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

803

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dmitry Frenkel

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

[diff] [blame]

804

{

805

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

806

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

807

},

808

],

809

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

810

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

Dmitry Frenkel

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

[diff] [blame]

811

},

812

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

813

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

814

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

Dmitry Frenkel

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

[diff] [blame]

815

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

816

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

Sai Cheemalapati

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

[diff] [blame]

817

{

Dmitry Frenkel

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

[diff] [blame]

818

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

819

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

Dmitry Frenkel

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

[diff] [blame]

820

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

Sai Cheemalapati

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

[diff] [blame]

821

},

822

],

823

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

824

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

825

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

Dmitry Frenkel

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

[diff] [blame]

826

"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-11-16 11:05:03 -0700

[diff] [blame]

827

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

828

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

829

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

830

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

831

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

832

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

833

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

Sai Cheemalapati

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

[diff] [blame]

834

},

Dmitry Frenkel

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

[diff] [blame]

835

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

836

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

Dmitry Frenkel

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

[diff] [blame]

837

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

838

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

839

{

Dmitry Frenkel

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

[diff] [blame]

840

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

841

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

Dmitry Frenkel

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

[diff] [blame]

842

},

843

],

844

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

845

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

Bu Sun Kim

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

[diff] [blame]

846

},

Dmitry Frenkel

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

[diff] [blame]

847

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

848

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

849

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

850

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

851

"labels": [ # Map of One Platform 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])?)?`.

852

{ # Label object for DeploymentUpdate

853

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

854

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

855

},

856

],

857

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

858

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

859

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

860

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

861

},

862

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

863

"password": "A String",

"user": "A String",

},

},

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

868

},

Dmitry Frenkel

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

[diff] [blame]

869

}

Sai Cheemalapati

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

[diff] [blame]

870

Dmitry Frenkel

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

[diff] [blame]

871

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.

872

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

873

Allowed values

Dmitry Frenkel

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

[diff] [blame]

874

DELETE -

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

875

ABANDON -

Sai Cheemalapati

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

[diff] [blame]

876

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

877

Allowed values

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

878

CREATE_OR_ACQUIRE -

Sai Cheemalapati

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

[diff] [blame]

879

ACQUIRE -

Bu Sun Kim

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

[diff] [blame]

880

CREATE -

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

881

x__xgafv: string, V1 error format.

882

Allowed values

883

1 - v1 error format

884

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

885

886

Returns:

887

An object of the form:

888

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

889

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

890

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

Dmitry Frenkel

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

[diff] [blame]

891

"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-11-16 11:05:03 -0700

[diff] [blame]

892

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

893

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

894

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

895

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

Bu Sun Kim

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

[diff] [blame]

896

"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-11-16 11:05:03 -0700

[diff] [blame]

897

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

898

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

Bu Sun Kim

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

[diff] [blame]

899

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

900

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

901

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

902

{

903

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

904

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

905

},

906

],

Dmitry Frenkel

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

[diff] [blame]

907

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

908

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

Bu Sun Kim

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

[diff] [blame]

909

},

910

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

911

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

912

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

Dmitry Frenkel

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

[diff] [blame]

913

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

914

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

915

{

Dmitry Frenkel

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

[diff] [blame]

916

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

917

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

Dmitry Frenkel

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

[diff] [blame]

918

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

919

},

920

],

921

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

922

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

923

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

Dmitry Frenkel

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

[diff] [blame]

924

"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-11-16 11:05:03 -0700

[diff] [blame]

925

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

926

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

927

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

928

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

929

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

930

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

931

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

936

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>

Sai Cheemalapati

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

[diff] [blame]

937

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

938

939

Args:

940

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

Bu Sun Kim

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

[diff] [blame]

941

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

Dan O'Meara

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

[diff] [blame]

942

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

943

The object takes the form of:

944

Bu Sun Kim

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

[diff] [blame]

945

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

946

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

947

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

948

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

949

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

950

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

951

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

952

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

953

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Sai Cheemalapati

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

[diff] [blame]

954

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

955

"bindingId": "A String",

956

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

"A String",

],

},

],

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

962

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # 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.

963

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. 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-27 12:20:54 -0700

[diff] [blame]

964

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

965

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

Dmitry Frenkel

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

[diff] [blame]

966

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

967

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

968

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

969

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

970

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

971

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

972

},

973

"bindingId": "A String",

974

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Dmitry Frenkel

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

[diff] [blame]

975

"A String",

976

],

Sai Cheemalapati

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

[diff] [blame]

977

},

978

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

979

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

Dmitry Frenkel

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

[diff] [blame]

980

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

981

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Dmitry Frenkel

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

[diff] [blame]

982

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

983

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

984

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

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

[diff] [blame]

985

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

986

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Sai Cheemalapati

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

[diff] [blame]

991

},

Bu Sun Kim

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

[diff] [blame]

992

],

Bu Sun Kim

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

[diff] [blame]

993

},

Dmitry Frenkel

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

[diff] [blame]

994

}

995

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

996

x__xgafv: string, V1 error format.

997

Allowed values

998

1 - v1 error format

999

2 - v2 error format

Dmitry Frenkel

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

[diff] [blame]

1000

1001

Returns:

1002

An object of the form:

1003

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1004

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

1005

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dmitry Frenkel

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

[diff] [blame]

1006

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

1007

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

1008

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1009

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

1010

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

1011

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

1012

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

1013

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

1014

},

1015

"bindingId": "A String",

1016

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

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

[diff] [blame]

1017

"A String",

Sai Cheemalapati

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

[diff] [blame]

1018

],

1019

},

1020

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1021

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

Dmitry Frenkel

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

[diff] [blame]

1022

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1023

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Dmitry Frenkel

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

[diff] [blame]

1024

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

1025

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1026

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Dmitry Frenkel

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

[diff] [blame]

1027

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1028

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Bu Sun Kim

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

[diff] [blame]

1033

},

1034

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1039

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

Sai Cheemalapati

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

[diff] [blame]

1040

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

1041

1042

Args:

1043

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

1044

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

Dan O'Meara

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

[diff] [blame]

1045

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1046

The object takes the form of:

1047

1048

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1049

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

1050

}

1051

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1052

x__xgafv: string, V1 error format.

1053

Allowed values

1054

1 - v1 error format

1055

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

1056

1057

Returns:

1058

An object of the form:

1059

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1060

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

1061

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

Dmitry Frenkel

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

[diff] [blame]

1062

"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-11-16 11:05:03 -0700

[diff] [blame]

1063

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

1064

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

1065

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

1066

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

Bu Sun Kim

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

[diff] [blame]

1067

"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-11-16 11:05:03 -0700

[diff] [blame]

1068

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

1069

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

Bu Sun Kim

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

[diff] [blame]

1070

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

1071

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1072

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

1073

{

1074

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

1075

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

1076

},

1077

],

Dmitry Frenkel

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

[diff] [blame]

1078

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1079

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

Bu Sun Kim

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

[diff] [blame]

1080

},

1081

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1082

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

1083

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

Dmitry Frenkel

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

[diff] [blame]

1084

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

1085

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

1086

{

Dmitry Frenkel

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

[diff] [blame]

1087

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1088

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

Dmitry Frenkel

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

[diff] [blame]

1089

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

1090

},

1091

],

1092

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1093

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

1094

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

Dmitry Frenkel

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

[diff] [blame]

1095

"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-11-16 11:05:03 -0700

[diff] [blame]

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1107

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>

Sai Cheemalapati

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

[diff] [blame]

1108

<pre>Returns permissions that a caller has on the specified resource.

1109

1110

Args:

1111

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

Bu Sun Kim

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

[diff] [blame]

1112

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

Dan O'Meara

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

[diff] [blame]

1113

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1114

The object takes the form of:

1115

1116

{

Bu Sun Kim

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

[diff] [blame]

1117

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1118

"A String",

Sai Cheemalapati

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

[diff] [blame]

],

}

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1122

x__xgafv: string, V1 error format.

1123

Allowed values

1124

1 - v1 error format

1125

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

1126

1127

Returns:

1128

An object of the form:

1129

1130

{

Bu Sun Kim

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

[diff] [blame]

1131

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1132

"A String",

Sai Cheemalapati

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

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1138

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

Sai Cheemalapati

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

[diff] [blame]

1139

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

1140

1141

Args:

1142

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

1143

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

Dan O'Meara

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

[diff] [blame]

1144

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1145

The object takes the form of:

1146

1147

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1148

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

1149

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

1150

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

1151

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

1152

},

1153

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

1154

"password": "A String",

"user": "A String",

},

},

"labels": [ # Map of One Platform 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])?)?`.

1159

{ # Label object for Deployments

1160

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

1161

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

Dmitry Frenkel

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

[diff] [blame]

1162

},

1163

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1164

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

1165

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

Dmitry Frenkel

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

[diff] [blame]

1166

"id": "A String",

Dmitry Frenkel

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

[diff] [blame]

1167

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

1168

{ # Output object for Deployments

1169

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

1170

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

1171

},

1172

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1173

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

1174

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

1175

"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. # Output only. The Operation that most recently ran, or is currently running, on this deployment.

1176

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

Dmitry Frenkel

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

[diff] [blame]

1177

"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-11-16 11:05:03 -0700

[diff] [blame]

1178

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

1179

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

1180

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

1181

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

Dmitry Frenkel

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

[diff] [blame]

1182

"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-11-16 11:05:03 -0700

[diff] [blame]

1183

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

1184

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

Dmitry Frenkel

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

[diff] [blame]

1185

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

1186

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1187

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Dmitry Frenkel

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

[diff] [blame]

1188

{

1189

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

1190

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

1191

},

1192

],

1193

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1194

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

Dmitry Frenkel

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

[diff] [blame]

1195

},

1196

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1197

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

1198

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

Dmitry Frenkel

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

[diff] [blame]

1199

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

1200

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

Sai Cheemalapati

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

[diff] [blame]

1201

{

Dmitry Frenkel

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

[diff] [blame]

1202

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1203

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

Dmitry Frenkel

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

[diff] [blame]

1204

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1205

},

1206

],

1207

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1208

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1209

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1210

"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-11-16 11:05:03 -0700

[diff] [blame]

1211

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1212

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1213

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1214

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1215

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1216

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1217

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1218

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1219

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1220

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1221

"target": { # [Input Only] The parameters that define your deployment, including the deployment configuration and relevant templates.

1222

"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.

1223

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1224

"content": "A String", # The contents of the file.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1225

"name": "A String", # The name of the file.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1226

},

1227

],

1228

"config": { # The configuration to use for this deployment.

1229

"content": "A String", # The contents of the file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1230

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1231

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1232

"selfLink": "A String", # Output only. Server defined URL for the resource.

1233

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this deployment, the updated configuration appears here.

1234

"description": "A String", # Output only. An optional user-provided description of the deployment after the current update has been applied.

1235

"labels": [ # Map of One Platform 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])?)?`.

1236

{ # Label object for DeploymentUpdate

1237

"value": "A String", # Value of the label

1238

"key": "A String", # Key of the label

1239

},

1240

],

1241

"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.

1242

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

1243

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

1244

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

1245

},

1246

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

1247

"password": "A String",

"user": "A String",

},

},

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this deployment.

1252

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1253

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1254

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1255

createPolicy: string, Sets the policy to use for creating new resources.

1256

Allowed values

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1257

CREATE_OR_ACQUIRE -

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1258

ACQUIRE -

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1259

CREATE -

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1260

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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1261

deletePolicy: string, Sets the policy to use for deleting resources.

Allowed values

DELETE -

ABANDON -

x__xgafv: string, V1 error format.

1266

Allowed values

1267

1 - v1 error format

1268

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1269

1270

Returns:

1271

An object of the form:

1272

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1273

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

1274

"name": "A String", # [Output Only] Name of the operation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1275

"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-11-16 11:05:03 -0700

[diff] [blame]

1276

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1277

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1278

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1279

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

"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-11-16 11:05:03 -0700

[diff] [blame]

1281

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1282

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1284

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1285

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1286

{

1287

"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).

1288

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1289

},

1290

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1291

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1292

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1293

},

1294

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1295

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1296

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1297

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1298

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1299

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1300

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1301

"code": "A String", # [Output Only] The error type identifier for this error.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1302

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1303

},

1304

],

1305

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1306

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1307

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1308

"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-11-16 11:05:03 -0700

[diff] [blame]

1309

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1310

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1311

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1312

"kind": "deploymentmanager#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1313

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1314

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1315

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Sai Cheemalapati