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

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

[diff] [blame]

92

93

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

94

<p class="firstline">Returns the specified Project resource.</p>

95

96

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

Bu Sun Kim

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

[diff] [blame]

97

<p class="firstline">Gets the shared VPC host project that this project links to. May be empty if no link exists.</p>

Sai Cheemalapati

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

[diff] [blame]

98

Bu Sun Kim

d059ad8

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Gets service resources (a.k.a service project) associated with this host project.</p>

Sai Cheemalapati

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

[diff] [blame]

101

Sai Cheemalapati

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

[diff] [blame]

102

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

103

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

104

Bu Sun Kim

d059ad8

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

<p class="firstline">Lists all shared VPC host projects visible to the user in an organization.</p>

Sai Cheemalapati

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

[diff] [blame]

107

Sai Cheemalapati

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

[diff] [blame]

108

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

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

<p class="firstline">Moves a persistent disk from one zone to another.</p>

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

<p class="firstline">Moves an instance and its attached persistent disks from one zone to another.</p>

116

Dan O'Meara

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

[diff] [blame]

117

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

Sai Cheemalapati

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

[diff] [blame]

118

<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p>

119

Dan O'Meara

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

[diff] [blame]

120

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

Bu Sun Kim

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

[diff] [blame]

121

<p class="firstline">Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.</p>

122

Dan O'Meara

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

[diff] [blame]

123

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

Sai Cheemalapati

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

[diff] [blame]

124

<p class="firstline">Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".</p>

125

Dan O'Meara

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

[diff] [blame]

126

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

Sai Cheemalapati

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

[diff] [blame]

127

<p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</p>

128

<h3>Method Details</h3>

129

Dmitry Frenkel

3e17f89

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

[diff] [blame]

130

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

131

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

135

<code class="details" id="disableXpnHost">disableXpnHost(project, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

136

<pre>Disable this project as a shared VPC host project.

Sai Cheemalapati

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

[diff] [blame]

137

138

Args:

139

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

Bu Sun Kim

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

[diff] [blame]

140

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

141

142

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

143

144

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

Sai Cheemalapati

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

[diff] [blame]

145

146

Returns:

147

An object of the form:

148

Bu Sun Kim

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

[diff] [blame]

149

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

150

#

151

# Google Compute Engine has three Operation resources:

152

#

153

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

154

#

155

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

156

#

157

# Operations can be global, regional or zonal.

158

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

159

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

160

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

161

#

162

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

163

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

164

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

165

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

166

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

167

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

168

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

Bu Sun Kim

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

[diff] [blame]

169

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

170

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

171

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

172

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

Bu Sun Kim

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

[diff] [blame]

173

},

174

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

175

},

176

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

177

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

178

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

179

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

180

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

181

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

182

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

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

192

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

193

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

194

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

195

{

196

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

197

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

198

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

199

{

200

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

201

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

202

},

203

],

204

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

205

},

206

],

207

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

208

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

212

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

Bu Sun Kim

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

[diff] [blame]

213

<pre>Disable a service resource (also known as service project) associated with this host project.

Sai Cheemalapati

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

[diff] [blame]

214

215

Args:

216

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

Dan O'Meara

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

[diff] [blame]

217

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

218

The object takes the form of:

219

220

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

221

"xpnResource": { # Service resource (a.k.a service project) ID. # Service resource (a.k.a service project) ID.

222

"id": "A String", # The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678).

223

"type": "A String", # The type of the service resource.

224

},

225

}

Sai Cheemalapati

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

[diff] [blame]

226

Bu Sun Kim

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

[diff] [blame]

227

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

228

229

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

230

231

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

Sai Cheemalapati

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

[diff] [blame]

232

233

Returns:

234

An object of the form:

235

Bu Sun Kim

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

[diff] [blame]

236

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

237

#

238

# Google Compute Engine has three Operation resources:

239

#

240

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

241

#

242

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

243

#

244

# Operations can be global, regional or zonal.

245

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

246

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

247

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

248

#

249

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

250

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

251

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

252

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

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

257

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

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

},

261

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

262

},

263

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

264

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

265

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

266

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

267

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

268

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

269

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

270

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

271

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

{

283

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

284

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

285

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

286

{

287

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

288

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

289

},

290

],

291

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

292

},

293

],

294

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

295

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

299

<code class="details" id="enableXpnHost">enableXpnHost(project, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

300

<pre>Enable this project as a shared VPC host project.

Sai Cheemalapati

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

[diff] [blame]

301

302

Args:

303

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

Bu Sun Kim

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

[diff] [blame]

304

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

305

306

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

307

308

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

Sai Cheemalapati

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

[diff] [blame]

309

310

Returns:

311

An object of the form:

312

Bu Sun Kim

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

[diff] [blame]

313

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

314

#

315

# Google Compute Engine has three Operation resources:

316

#

317

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

318

#

319

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

320

#

321

# Operations can be global, regional or zonal.

322

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

323

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

324

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

325

#

326

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

327

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

328

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

329

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

330

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

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

334

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

335

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

336

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

Bu Sun Kim

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

[diff] [blame]

337

},

338

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

339

},

340

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

341

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

342

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

343

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

344

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

345

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

346

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

{

360

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

361

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

362

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

363

{

364

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

365

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

366

},

367

],

368

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

369

},

370

],

371

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

372

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

376

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

Bu Sun Kim

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

[diff] [blame]

377

<pre>Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.

Sai Cheemalapati

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

[diff] [blame]

378

379

Args:

380

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

Dan O'Meara

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

[diff] [blame]

381

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

382

The object takes the form of:

383

384

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

385

"xpnResource": { # Service resource (a.k.a service project) ID. # Service resource (a.k.a service project) ID.

386

"id": "A String", # The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678).

387

"type": "A String", # The type of the service resource.

388

},

389

}

Sai Cheemalapati

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

[diff] [blame]

390

Bu Sun Kim

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

[diff] [blame]

391

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

392

393

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

394

395

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

Sai Cheemalapati

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

[diff] [blame]

396

397

Returns:

398

An object of the form:

399

Bu Sun Kim

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

[diff] [blame]

400

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

401

#

402

# Google Compute Engine has three Operation resources:

403

#

404

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

405

#

406

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

407

#

408

# Operations can be global, regional or zonal.

409

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

410

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

411

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

412

#

413

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

414

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

415

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

416

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

417

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

418

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

419

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

Bu Sun Kim

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

[diff] [blame]

420

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

421

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

422

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

423

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

Bu Sun Kim

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

[diff] [blame]

424

},

425

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

426

},

427

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

428

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

429

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

430

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

431

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

432

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

433

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

434

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

435

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

436

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

437

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

438

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

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

{

447

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

448

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

449

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

450

{

451

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

452

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

453

},

454

],

455

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

456

},

457

],

458

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

459

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

464

<pre>Returns the specified Project resource.

465

466

Args:

467

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

468

469

Returns:

470

An object of the form:

471

Bu Sun Kim

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

[diff] [blame]

472

{ # Represents a Project resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

473

#

474

# A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==)

475

"commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

476

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

477

#

478

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

479

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

480

{

481

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

482

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Sai Cheemalapati

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

[diff] [blame]

483

},

484

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

485

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

486

},

487

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

488

"defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.

489

"defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.

490

"description": "A String", # An optional textual description of the resource.

491

"enabledFeatures": [ # Restricted features enabled for use on this project.

492

"A String",

493

],

494

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.

495

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

496

"name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.

497

"quotas": [ # [Output Only] Quotas assigned to this project.

498

{ # A quotas entry.

499

"limit": 3.14, # [Output Only] Quota limit for this metric.

500

"metric": "A String", # [Output Only] Name of the quota metric.

501

"owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied.

502

"usage": 3.14, # [Output Only] Current usage of this metric.

Sai Cheemalapati

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

[diff] [blame]

503

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

504

],

505

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

506

"usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.

507

"bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

508

"reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

509

},

510

"xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.

511

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

<code class="details" id="getXpnHost">getXpnHost(project)</code>

Bu Sun Kim

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

[diff] [blame]

516

<pre>Gets the shared VPC host project that this project links to. May be empty if no link exists.

Sai Cheemalapati

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

[diff] [blame]

517

518

Args:

519

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

520

521

Returns:

522

An object of the form:

523

Bu Sun Kim

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

[diff] [blame]

524

{ # Represents a Project resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

525

#

526

# A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==)

527

"commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

528

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

529

#

530

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

531

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

532

{

533

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

534

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Sai Cheemalapati

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

[diff] [blame]

535

},

536

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

537

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

538

},

539

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

540

"defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.

541

"defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.

542

"description": "A String", # An optional textual description of the resource.

543

"enabledFeatures": [ # Restricted features enabled for use on this project.

544

"A String",

545

],

546

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.

547

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

548

"name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.

549

"quotas": [ # [Output Only] Quotas assigned to this project.

550

{ # A quotas entry.

551

"limit": 3.14, # [Output Only] Quota limit for this metric.

552

"metric": "A String", # [Output Only] Name of the quota metric.

553

"owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied.

554

"usage": 3.14, # [Output Only] Current usage of this metric.

Sai Cheemalapati

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

[diff] [blame]

555

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

556

],

557

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

558

"usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.

559

"bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

560

"reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

561

},

562

"xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.

563

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

567

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

Bu Sun Kim

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

[diff] [blame]

568

<pre>Gets service resources (a.k.a service project) associated with this host project.

Sai Cheemalapati

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

[diff] [blame]

569

570

Args:

571

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

Dan O'Meara

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

[diff] [blame]

572

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

Bu Sun Kim

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

[diff] [blame]

573

Dan O'Meara

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

[diff] [blame]

574

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

Bu Sun Kim

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

[diff] [blame]

575

Dan O'Meara

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

[diff] [blame]

576

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.

Bu Sun Kim

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

[diff] [blame]

577

Bu Sun Kim

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

[diff] [blame]

578

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

579

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

580

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

581

582

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.

583

584

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

585

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

586

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

587

588

Returns:

589

An object of the form:

590

591

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

592

"kind": "compute#projectsGetXpnResources", # [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)

593

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

594

"resources": [ # Service resources (a.k.a service projects) attached to this project as their shared VPC host.

595

{ # Service resource (a.k.a service project) ID.

596

"id": "A String", # The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678).

597

"type": "A String", # The type of the service resource.

598

},

599

],

600

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

604

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

605

<pre>Retrieves the next page of results.

606

607

Args:

608

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

609

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

610

611

Returns:

Bu Sun Kim

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

[diff] [blame]

612

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

Sai Cheemalapati

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

[diff] [blame]

613

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

618

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

Bu Sun Kim

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

[diff] [blame]

619

<pre>Lists all shared VPC host projects visible to the user in an organization.

Sai Cheemalapati

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

[diff] [blame]

620

621

Args:

622

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

Dan O'Meara

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

[diff] [blame]

623

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

624

The object takes the form of:

625

626

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

627

"organization": "A String", # Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.

628

}

Sai Cheemalapati

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

[diff] [blame]

629

Dan O'Meara

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

[diff] [blame]

630

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

Bu Sun Kim

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

[diff] [blame]

631

Dan O'Meara

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

[diff] [blame]

632

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

Bu Sun Kim

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

[diff] [blame]

633

Dan O'Meara

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

[diff] [blame]

634

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.

Bu Sun Kim

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

[diff] [blame]

635

Bu Sun Kim

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

[diff] [blame]

636

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

637

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

638

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

639

640

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.

641

642

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

643

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

644

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

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

[diff] [blame]

645

646

Returns:

647

An object of the form:

648

649

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

650

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

651

"items": [ # [Output Only] A list of shared VPC host project URLs.

652

{ # Represents a Project resource.

653

#

654

# A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==)

655

"commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information.

656

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

657

#

658

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

659

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

660

{

661

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

662

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Sai Cheemalapati

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

[diff] [blame]

663

},

664

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

665

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

Sai Cheemalapati

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

[diff] [blame]

666

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

667

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

668

"defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.

669

"defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project.

670

"description": "A String", # An optional textual description of the resource.

671

"enabledFeatures": [ # Restricted features enabled for use on this project.

672

"A String",

673

],

674

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.

675

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

676

"name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.

677

"quotas": [ # [Output Only] Quotas assigned to this project.

678

{ # A quotas entry.

679

"limit": 3.14, # [Output Only] Quota limit for this metric.

680

"metric": "A String", # [Output Only] Name of the quota metric.

681

"owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied.

682

"usage": 3.14, # [Output Only] Current usage of this metric.

Bu Sun Kim

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

[diff] [blame]

683

},

684

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

685

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

686

"usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored.

687

"bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

688

"reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

689

},

690

"xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated.

Bu Sun Kim

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

[diff] [blame]

691

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

692

],

693

"kind": "compute#xpnHostList", # [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.

694

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

695

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

696

"warning": { # [Output Only] Informational warning message.

697

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

698

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

699

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

700

{

701

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

702

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

703

},

704

],

705

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

706

},

707

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

711

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

712

<pre>Retrieves the next page of results.

713

714

Args:

715

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

716

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

717

718

Returns:

Bu Sun Kim

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

[diff] [blame]

719

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

Sai Cheemalapati

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

[diff] [blame]

720

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

725

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

Sai Cheemalapati

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

[diff] [blame]

726

<pre>Moves a persistent disk from one zone to another.

727

728

Args:

729

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

Dan O'Meara

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

[diff] [blame]

730

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

731

The object takes the form of:

732

733

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

734

"destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone:

735

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

736

# - projects/project/zones/zone

737

# - zones/zone

738

"targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk:

739

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

740

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

741

# - zones/zone/disks/disk

742

}

Sai Cheemalapati

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

[diff] [blame]

743

Bu Sun Kim

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

[diff] [blame]

744

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

745

746

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

747

748

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

Sai Cheemalapati

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

[diff] [blame]

749

750

Returns:

751

An object of the form:

752

Bu Sun Kim

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

[diff] [blame]

753

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

754

#

755

# Google Compute Engine has three Operation resources:

756

#

757

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

758

#

759

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

760

#

761

# Operations can be global, regional or zonal.

762

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

763

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

764

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

765

#

766

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

767

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

768

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

769

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

770

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

771

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

772

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

Bu Sun Kim

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

[diff] [blame]

773

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

774

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

775

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

776

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

Bu Sun Kim

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

[diff] [blame]

777

},

778

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

779

},

780

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

781

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

782

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

783

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

784

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

785

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

786

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

787

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

788

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

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

{

800

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

801

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

802

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

803

{

804

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

805

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

806

},

807

],

808

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

809

},

810

],

811

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

812

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

816

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

Sai Cheemalapati

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

[diff] [blame]

817

<pre>Moves an instance and its attached persistent disks from one zone to another.

818

819

Args:

820

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

Dan O'Meara

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

[diff] [blame]

821

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

822

The object takes the form of:

823

824

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

825

"destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone:

826

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

827

# - projects/project/zones/zone

828

# - zones/zone

829

"targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance:

830

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance

831

# - projects/project/zones/zone/instances/instance

832

# - zones/zone/instances/instance

833

}

Sai Cheemalapati

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

[diff] [blame]

834

Bu Sun Kim

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

[diff] [blame]

835

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

836

837

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

838

839

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

Sai Cheemalapati

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

[diff] [blame]

840

841

Returns:

842

An object of the form:

843

Bu Sun Kim

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

[diff] [blame]

844

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

845

#

846

# Google Compute Engine has three Operation resources:

847

#

848

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

849

#

850

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

851

#

852

# Operations can be global, regional or zonal.

853

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

854

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

855

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

856

#

857

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

858

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

859

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

860

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

861

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

862

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

863

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

Bu Sun Kim

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

[diff] [blame]

864

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

865

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

866

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

867

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

Bu Sun Kim

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

[diff] [blame]

868

},

869

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

870

},

871

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

872

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

873

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

874

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

875

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

876

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

877

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

878

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

879

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

880

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

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

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

889

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

890

{

891

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

892

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

893

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

894

{

895

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

896

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

897

},

898

],

899

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

900

},

901

],

902

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

903

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

907

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

Sai Cheemalapati

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

[diff] [blame]

908

<pre>Sets metadata common to all instances within the specified project using the data included in the request.

909

910

Args:

911

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

Dan O'Meara

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

[diff] [blame]

912

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

913

The object takes the form of:

914

915

{ # A metadata key/value entry.

Bu Sun Kim

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

[diff] [blame]

916

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.

Bu Sun Kim

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

[diff] [blame]

917

#

918

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

Bu Sun Kim

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

[diff] [blame]

919

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

920

{

921

"key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.

922

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

923

},

924

],

925

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

Sai Cheemalapati

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

[diff] [blame]

926

}

927

Bu Sun Kim

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

[diff] [blame]

928

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

929

930

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

931

932

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

Sai Cheemalapati

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

[diff] [blame]

933

934

Returns:

935

An object of the form:

936

Bu Sun Kim

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

[diff] [blame]

937

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

938

#

939

# Google Compute Engine has three Operation resources:

940

#

941

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

942

#

943

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

944

#

945

# Operations can be global, regional or zonal.

946

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

947

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

948

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

949

#

950

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

951

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

952

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

953

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

954

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

955

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

956

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

Bu Sun Kim

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

[diff] [blame]

957

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

958

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

959

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

960

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

Bu Sun Kim

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

[diff] [blame]

961

},

962

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

963

},

964

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

965

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

966

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

967

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

968

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

969

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

970

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

971

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

972

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

973

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

974

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

975

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

976

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

977

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

978

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

979

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

980

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

981

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

982

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

983

{

984

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

985

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

986

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

987

{

988

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

989

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

990

},

991

],

992

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

993

},

994

],

995

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

996

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

<pre>Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.

1002

1003

Args:

1004

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

Dan O'Meara

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

[diff] [blame]

1005

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1006

The object takes the form of:

1007

1008

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1009

"networkTier": "A String", # Default network tier to be set.

1010

}

Bu Sun Kim

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

[diff] [blame]

1011

1012

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

1013

1014

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

1015

1016

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

1017

1018

Returns:

1019

An object of the form:

1020

1021

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1022

#

1023

# Google Compute Engine has three Operation resources:

1024

#

1025

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

1026

#

1027

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

1028

#

1029

# Operations can be global, regional or zonal.

1030

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

1031

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

1032

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

1033

#

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

Bu Sun Kim

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

[diff] [blame]

1041

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1042

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

1043

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

1044

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

Bu Sun Kim

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

[diff] [blame]

1045

},

1046

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1047

},

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1054

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

{

1068

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

1069

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

1070

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

1071

{

1072

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

1073

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

1074

},

1075

],

1076

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

1077

},

1078

],

1079

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

1080

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1084

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

Bu Sun Kim

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

[diff] [blame]

1085

<pre>Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".

Sai Cheemalapati

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

[diff] [blame]

1086

1087

Args:

1088

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

Dan O'Meara

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

[diff] [blame]

1089

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1090

The object takes the form of:

1091

1092

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1093

"email": "A String", # Email address of the service account.

1094

}

Sai Cheemalapati

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

[diff] [blame]

1095

Bu Sun Kim

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

[diff] [blame]

1096

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

1097

1098

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

1099

1100

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

Sai Cheemalapati

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

[diff] [blame]

1101

1102

Returns:

1103

An object of the form:

1104

Bu Sun Kim

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

[diff] [blame]

1105

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1106

#

1107

# Google Compute Engine has three Operation resources:

1108

#

1109

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

1110

#

1111

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

1112

#

1113

# Operations can be global, regional or zonal.

1114

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

1115

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

1116

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

1117

#

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

Bu Sun Kim

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

[diff] [blame]

1125

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1126

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

1127

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

1128

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

Bu Sun Kim

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

[diff] [blame]

1129

},

1130

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1131

},

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1138

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1139

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

1140

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

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

{

1152

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

1153

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

1154

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

1155

{

1156

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

1157

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

1158

},

1159

],

1160

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

1161

},

1162

],

1163

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

1164

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

1168

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

Sai Cheemalapati

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

[diff] [blame]

1169

<pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

1170

1171

Args:

1172

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

Dan O'Meara

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

[diff] [blame]

1173

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1174

The object takes the form of:

1175

1176

{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.

Bu Sun Kim

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

[diff] [blame]

1177

"bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.

1178

"reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.

Sai Cheemalapati

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

[diff] [blame]

1179

}

1180

Bu Sun Kim

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

[diff] [blame]

1181

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

1182

1183

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

1184

1185

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

Sai Cheemalapati

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

[diff] [blame]

1186

1187

Returns:

1188

An object of the form:

1189

Bu Sun Kim

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

[diff] [blame]

1190

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1191

#

1192

# Google Compute Engine has three Operation resources:

1193

#

1194

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

1195

#

1196

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

1197

#

1198

# Operations can be global, regional or zonal.

1199

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

1200

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

1201

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

1202

#

1203

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

1204

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

1205

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

1206

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

1207

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

1208

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

1209

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

Bu Sun Kim

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

[diff] [blame]

1210

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1211

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

1212

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

1213

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

Bu Sun Kim

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

[diff] [blame]

1214

},

1215

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1216

},

1217

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

1218

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

1219

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

1220

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

1221

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

1222

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1223

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot