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

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

[diff] [blame]

92

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

93

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

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

94

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

Sai Cheemalapati

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

[diff] [blame]

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

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

[diff] [blame]

98

Dmitry Frenkel

3e17f89

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

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

[diff] [blame]

101

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

Dmitry Frenkel

3e17f89

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

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

[diff] [blame]

107

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>

Nathaniel Manista

2015-03-10 23:29:22 +0000

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

118

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

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="#setUsageExportBucket">setUsageExportBucket(project, body=None, requestId=None)</a></code></p>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

124

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

125

<h3>Method Details</h3>

126

Dmitry Frenkel

3e17f89

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

[diff] [blame]

127

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

128

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

132

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

133

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

Sai Cheemalapati

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

[diff] [blame]

134

135

Args:

136

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

Bu Sun Kim

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

[diff] [blame]

137

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.

138

139

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.

140

141

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

Sai Cheemalapati

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

[diff] [blame]

142

143

Returns:

144

An object of the form:

145

Bu Sun Kim

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

[diff] [blame]

146

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

147

#

148

# Google Compute Engine has three Operation resources:

149

#

150

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

151

#

152

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

153

#

154

# Operations can be global, regional or zonal.

155

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

156

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

157

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

158

#

159

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

160

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

161

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

162

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

163

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

164

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

165

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

Bu Sun Kim

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

[diff] [blame]

166

{

Yoshi Automation Bot

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

[diff] [blame]

167

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

168

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

169

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

Bu Sun Kim

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

[diff] [blame]

170

},

171

],

Yoshi Automation Bot

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

[diff] [blame]

172

},

173

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

174

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

175

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

176

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

177

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

178

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

yoshi-code-bot

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

[diff] [blame^]

179

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

180

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

181

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

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

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

190

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

191

{

192

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

193

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

194

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

195

{

196

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

197

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

198

},

199

],

200

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

201

},

202

],

203

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

204

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

208

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

Bu Sun Kim

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

[diff] [blame]

209

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

Sai Cheemalapati

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

[diff] [blame]

210

211

Args:

212

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

Dan O'Meara

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

[diff] [blame]

213

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

214

The object takes the form of:

215

216

{

Yoshi Automation Bot

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

[diff] [blame]

217

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

218

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

219

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

220

},

221

}

Sai Cheemalapati

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

[diff] [blame]

222

Bu Sun Kim

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

[diff] [blame]

223

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.

224

225

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.

226

227

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

Sai Cheemalapati

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

[diff] [blame]

228

229

Returns:

230

An object of the form:

231

Bu Sun Kim

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

[diff] [blame]

232

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

233

#

234

# Google Compute Engine has three Operation resources:

235

#

236

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

237

#

238

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

239

#

240

# Operations can be global, regional or zonal.

241

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

242

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

243

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

244

#

245

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

246

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

247

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

248

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

249

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

250

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

251

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

Bu Sun Kim

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

[diff] [blame]

252

{

Yoshi Automation Bot

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

[diff] [blame]

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

},

257

],

Yoshi Automation Bot

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

[diff] [blame]

258

},

259

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

260

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

261

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

262

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

263

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

264

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

yoshi-code-bot

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

[diff] [blame^]

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

{

278

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

279

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

280

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

281

{

282

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

283

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

284

},

285

],

286

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

287

},

288

],

289

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

290

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

294

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

295

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

Sai Cheemalapati

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

[diff] [blame]

296

297

Args:

298

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

Bu Sun Kim

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

[diff] [blame]

299

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.

300

301

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.

302

303

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

Sai Cheemalapati

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

[diff] [blame]

304

305

Returns:

306

An object of the form:

307

Bu Sun Kim

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

[diff] [blame]

308

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

309

#

310

# Google Compute Engine has three Operation resources:

311

#

312

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

313

#

314

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

315

#

316

# Operations can be global, regional or zonal.

317

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

318

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

319

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

320

#

321

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

322

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

323

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

324

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

325

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

326

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

327

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

Bu Sun Kim

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

[diff] [blame]

328

{

Yoshi Automation Bot

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

[diff] [blame]

329

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

330

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

331

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

Bu Sun Kim

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

[diff] [blame]

332

},

333

],

Yoshi Automation Bot

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

[diff] [blame]

334

},

335

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

336

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

337

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

338

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

339

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

340

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

yoshi-code-bot

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

[diff] [blame^]

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

{

354

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

355

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

356

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

357

{

358

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

359

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

360

},

361

],

362

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

363

},

364

],

365

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

366

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

370

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

Bu Sun Kim

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

[diff] [blame]

371

<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

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

[diff] [blame]

372

373

Args:

374

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

Dan O'Meara

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

[diff] [blame]

375

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

376

The object takes the form of:

377

378

{

Yoshi Automation Bot

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

[diff] [blame]

379

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

380

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

381

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

382

},

383

}

Sai Cheemalapati

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

[diff] [blame]

384

Bu Sun Kim

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

[diff] [blame]

385

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.

386

387

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.

388

389

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

Sai Cheemalapati

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

[diff] [blame]

390

391

Returns:

392

An object of the form:

393

Bu Sun Kim

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

[diff] [blame]

394

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

395

#

396

# Google Compute Engine has three Operation resources:

397

#

398

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

399

#

400

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

401

#

402

# Operations can be global, regional or zonal.

403

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

404

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

405

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

406

#

407

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

408

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

409

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

410

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

411

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

412

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

413

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

Bu Sun Kim

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

[diff] [blame]

414

{

Yoshi Automation Bot

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

[diff] [blame]

415

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

416

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

417

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

Bu Sun Kim

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

[diff] [blame]

418

},

419

],

Yoshi Automation Bot

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

[diff] [blame]

420

},

421

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

422

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

423

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

424

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

425

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

426

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

yoshi-code-bot

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

[diff] [blame^]

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

{

440

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

441

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

442

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

443

{

444

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

445

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

446

},

447

],

448

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

449

},

450

],

451

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

452

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

456

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

Jon Wayne Parrott

0a471d3

2016-05-19 10:54:38 -0700

[diff] [blame]

457

<pre>Returns the specified Project resource.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

458

459

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

460

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

461

462

Returns:

463

An object of the form:

464

Bu Sun Kim

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

[diff] [blame]

465

{ # Represents a Project resource.

Yoshi Automation Bot

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

[diff] [blame]

466

#

467

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

468

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

469

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

470

#

471

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

472

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

473

{

474

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

475

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

476

},

477

],

Yoshi Automation Bot

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

[diff] [blame]

478

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

479

},

480

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

481

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

482

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

483

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

484

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

485

"A String",

486

],

487

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

488

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

489

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

490

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

491

{ # A quotas entry.

492

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

493

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

494

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

495

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

Sai Cheemalapati

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

[diff] [blame]

496

},

Yoshi Automation Bot

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

[diff] [blame]

497

],

498

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

499

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

500

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

501

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

502

},

503

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

504

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Sai Cheemalapati

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

[diff] [blame]

508

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

Bu Sun Kim

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

[diff] [blame]

509

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

Sai Cheemalapati

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

[diff] [blame]

510

511

Args:

512

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

513

514

Returns:

515

An object of the form:

516

Bu Sun Kim

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

[diff] [blame]

517

{ # Represents a Project resource.

Yoshi Automation Bot

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

[diff] [blame]

518

#

519

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

520

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

521

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

522

#

523

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

524

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

525

{

526

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

527

"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

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

[diff] [blame]

528

},

529

],

Yoshi Automation Bot

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

[diff] [blame]

530

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

531

},

532

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

533

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

534

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

535

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

536

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

537

"A String",

538

],

539

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

540

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

541

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

542

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

543

{ # A quotas entry.

544

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

545

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

546

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

547

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

Sai Cheemalapati

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

[diff] [blame]

548

},

Yoshi Automation Bot

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

[diff] [blame]

549

],

550

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

551

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

552

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

553

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

554

},

555

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

556

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

560

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

561

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

Sai Cheemalapati

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

[diff] [blame]

562

563

Args:

564

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

Dan O'Meara

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

[diff] [blame]

565

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]

566

Dan O'Meara

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

[diff] [blame]

567

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]

568

Dan O'Meara

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

[diff] [blame]

569

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]

570

Bu Sun Kim

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

[diff] [blame]

571

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

572

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

573

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

574

575

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.

576

577

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

578

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

579

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

Sai Cheemalapati

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

[diff] [blame]

580

581

Returns:

582

An object of the form:

583

584

{

Yoshi Automation Bot

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

[diff] [blame]

585

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

586

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

587

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

588

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

589

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

590

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

591

},

592

],

593

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

598

<pre>Retrieves the next page of results.

599

600

Args:

601

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

602

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

603

604

Returns:

Bu Sun Kim

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

[diff] [blame]

605

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

Sai Cheemalapati

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

[diff] [blame]

606

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

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

611

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

612

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

Sai Cheemalapati

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

[diff] [blame]

613

614

Args:

615

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

Dan O'Meara

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

[diff] [blame]

616

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

617

The object takes the form of:

618

619

{

Yoshi Automation Bot

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

[diff] [blame]

620

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

621

}

Sai Cheemalapati

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

[diff] [blame]

622

Dan O'Meara

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

[diff] [blame]

623

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]

624

Dan O'Meara

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

[diff] [blame]

625

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]

626

Dan O'Meara

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

[diff] [blame]

627

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]

628

Bu Sun Kim

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

[diff] [blame]

629

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

630

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

631

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

632

633

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.

634

635

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

636

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

637

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

Sai Cheemalapati

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

[diff] [blame]

638

639

Returns:

640

An object of the form:

641

642

{

Yoshi Automation Bot

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

[diff] [blame]

643

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

644

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

645

{ # Represents a Project resource.

646

#

647

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

648

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

649

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

650

#

651

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

652

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

653

{

654

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

655

"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

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

[diff] [blame]

656

},

657

],

Yoshi Automation Bot

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

[diff] [blame]

658

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

Sai Cheemalapati

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

[diff] [blame]

659

},

Yoshi Automation Bot

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

[diff] [blame]

660

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

661

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

662

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

663

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

664

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

665

"A String",

666

],

667

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

668

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

669

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

670

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

671

{ # A quotas entry.

672

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

673

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

674

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

675

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

Bu Sun Kim

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

[diff] [blame]

676

},

677

],

Yoshi Automation Bot

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

[diff] [blame]

678

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

679

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

680

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

681

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

682

},

683

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

684

},

Yoshi Automation Bot

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

[diff] [blame]

685

],

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

{

694

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

695

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

696

},

697

],

698

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

699

},

700

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

705

<pre>Retrieves the next page of results.

706

707

Args:

708

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

709

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

710

711

Returns:

Bu Sun Kim

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

[diff] [blame]

712

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

Sai Cheemalapati

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

[diff] [blame]

713

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]

718

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

719

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

720

721

Args:

722

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

Dan O'Meara

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

[diff] [blame]

723

body: object, The request body.

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

724

The object takes the form of:

725

726

{

Yoshi Automation Bot

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

[diff] [blame]

727

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

728

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

729

# - projects/project/zones/zone

730

# - zones/zone

731

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

732

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

733

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

734

# - zones/zone/disks/disk

735

}

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

736

Bu Sun Kim

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

[diff] [blame]

737

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.

738

739

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.

740

741

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

742

743

Returns:

744

An object of the form:

745

Bu Sun Kim

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

[diff] [blame]

746

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

747

#

748

# Google Compute Engine has three Operation resources:

749

#

750

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

751

#

752

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

753

#

754

# Operations can be global, regional or zonal.

755

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

756

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

757

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

758

#

759

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

760

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

761

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

762

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

763

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

764

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

765

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

Bu Sun Kim

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

[diff] [blame]

766

{

Yoshi Automation Bot

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

[diff] [blame]

767

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

768

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

769

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

Bu Sun Kim

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

[diff] [blame]

770

},

771

],

Yoshi Automation Bot

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

[diff] [blame]

772

},

773

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

774

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

775

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

776

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

777

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

778

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

yoshi-code-bot

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

[diff] [blame^]

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

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

788

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

789

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

790

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

791

{

792

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

793

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

794

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

795

{

796

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

797

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

798

},

799

],

800

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

801

},

802

],

803

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

804

}</pre>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

808

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

809

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

810

811

Args:

812

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

Dan O'Meara

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

[diff] [blame]

813

body: object, The request body.

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

814

The object takes the form of:

815

816

{

Yoshi Automation Bot

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

[diff] [blame]

817

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

818

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

819

# - projects/project/zones/zone

820

# - zones/zone

821

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

822

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

823

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

824

# - zones/zone/instances/instance

825

}

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

826

Bu Sun Kim

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

[diff] [blame]

827

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.

828

829

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.

830

831

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

832

833

Returns:

834

An object of the form:

835

Bu Sun Kim

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

[diff] [blame]

836

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

837

#

838

# Google Compute Engine has three Operation resources:

839

#

840

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

841

#

842

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

843

#

844

# Operations can be global, regional or zonal.

845

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

846

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

847

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

848

#

849

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

850

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

851

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

852

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

853

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

854

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

855

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

Bu Sun Kim

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

[diff] [blame]

856

{

Yoshi Automation Bot

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

[diff] [blame]

857

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

858

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

859

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

Bu Sun Kim

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

[diff] [blame]

860

},

861

],

Yoshi Automation Bot

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

[diff] [blame]

862

},

863

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

864

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

865

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

866

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

867

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

868

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

yoshi-code-bot

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

[diff] [blame^]

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

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

881

{

882

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

883

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

884

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

885

{

886

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

887

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

888

},

889

],

890

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

891

},

892

],

893

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

894

}</pre>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

898

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

899

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

900

901

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

902

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

Dan O'Meara

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

[diff] [blame]

903

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

904

The object takes the form of:

905

906

{ # A metadata key/value entry.

Bu Sun Kim

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

[diff] [blame]

907

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

908

#

909

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

910

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

911

{

912

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

913

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

914

},

915

],

916

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

917

}

918

Bu Sun Kim

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

[diff] [blame]

919

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.

920

921

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.

922

923

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

924

925

Returns:

926

An object of the form:

927

Bu Sun Kim

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

[diff] [blame]

928

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

929

#

930

# Google Compute Engine has three Operation resources:

931

#

932

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

933

#

934

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

935

#

936

# Operations can be global, regional or zonal.

937

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

938

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

939

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

940

#

941

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

942

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

943

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

944

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

945

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

946

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

947

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

Bu Sun Kim

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

[diff] [blame]

948

{

Yoshi Automation Bot

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

[diff] [blame]

949

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

950

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

951

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

Bu Sun Kim

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

[diff] [blame]

952

},

953

],

Yoshi Automation Bot

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

[diff] [blame]

954

},

955

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

956

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

957

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

958

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

959

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

960

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

yoshi-code-bot

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

[diff] [blame^]

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

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

969

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

970

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

971

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

972

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

973

{

974

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

975

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

976

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

977

{

978

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

979

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

980

},

981

],

982

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

983

},

984

],

985

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

986

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

987

</div>

988

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

989

Dan O'Meara

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

[diff] [blame]

990

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

Bu Sun Kim

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

[diff] [blame]

991

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

992

993

Args:

994

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

Dan O'Meara

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

[diff] [blame]

995

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

996

The object takes the form of:

997

998

{

Yoshi Automation Bot

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

[diff] [blame]

999

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

1000

}

Bu Sun Kim

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

[diff] [blame]

1001

1002

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.

1003

1004

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.

1005

1006

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

1007

1008

Returns:

1009

An object of the form:

1010

1011

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1012

#

1013

# Google Compute Engine has three Operation resources:

1014

#

1015

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

1016

#

1017

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

1018

#

1019

# Operations can be global, regional or zonal.

1020

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

1021

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

1022

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

1023

#

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

Bu Sun Kim

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

[diff] [blame]

1031

{

Yoshi Automation Bot

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

[diff] [blame]

1032

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

1033

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

1034

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

Bu Sun Kim

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

[diff] [blame]

1035

},

1036

],

Yoshi Automation Bot

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

[diff] [blame]

1037

},

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

yoshi-code-bot

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

[diff] [blame^]

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

{

1057

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

1058

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

1059

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

1060

{

1061

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

1062

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

1063

},

1064

],

1065

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

1066

},

1067

],

1068

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

1069

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

1073

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1074

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1075

1076

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1077

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

Dan O'Meara

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

[diff] [blame]

1078

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1079

The object takes the form of:

1080

1081

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

1082

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

1083

"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

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

[diff] [blame]

1084

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1085

Bu Sun Kim

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

[diff] [blame]

1086

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.

1087

1088

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.

1089

1090

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1091

1092

Returns:

1093

An object of the form:

1094

Bu Sun Kim

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

[diff] [blame]

1095

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1096

#

1097

# Google Compute Engine has three Operation resources:

1098

#

1099

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

1100

#

1101

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

1102

#

1103

# Operations can be global, regional or zonal.

1104

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

1105

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

1106

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

1107

#

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

Bu Sun Kim

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

[diff] [blame]

1115

{

Yoshi Automation Bot

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

[diff] [blame]

1116

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

1117

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

1118

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

Bu Sun Kim

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

[diff] [blame]

1119

},

1120

],

Yoshi Automation Bot

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

[diff] [blame]

1121

},

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

yoshi-code-bot

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

[diff] [blame^]

1128

"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