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

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

[diff] [blame]

89

Sai Cheemalapati

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

[diff] [blame]

90

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

91

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

92

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

95

Bu Sun Kim

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

[diff] [blame^]

96

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

Bu Sun Kim

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

[diff] [blame]

97

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

Sai Cheemalapati

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

[diff] [blame]

98

99

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

100

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

101

Bu Sun Kim

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

[diff] [blame^]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

104

Sai Cheemalapati

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

[diff] [blame]

105

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

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Sai Cheemalapati

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

[diff] [blame]

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

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

116

Dan O'Meara

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

[diff] [blame]

117

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

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

Sai Cheemalapati

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

[diff] [blame]

121

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

122

<h3>Method Details</h3>

123

Bu Sun Kim

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

[diff] [blame]

124

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

125

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

Sai Cheemalapati

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

[diff] [blame]

126

127

Args:

128

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

Bu Sun Kim

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

[diff] [blame]

129

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.

130

131

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.

132

133

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-03-13 12:12:03 -0400

[diff] [blame]

134

135

Returns:

136

An object of the form:

137

Bu Sun Kim

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

[diff] [blame]

138

{ # Represents an Operation resource.

139

#

Dan O'Meara

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

[diff] [blame]

140

# Google Compute Engine has three Operation resources:

141

#

142

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

143

#

Bu Sun Kim

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

[diff] [blame]

144

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

145

#

146

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

147

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

148

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

149

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

Bu Sun Kim

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

[diff] [blame]

150

#

Dan O'Meara

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

[diff] [blame]

151

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

Bu Sun Kim

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

[diff] [blame^]

152

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

153

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

154

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

155

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

156

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

157

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

Sai Cheemalapati

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

[diff] [blame]

158

{

Bu Sun Kim

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

[diff] [blame^]

159

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

160

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

161

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

Sai Cheemalapati

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

[diff] [blame]

162

},

163

],

164

},

Bu Sun Kim

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

[diff] [blame^]

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

180

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

181

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

182

{

183

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

184

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

185

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

186

{

187

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

188

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

189

},

190

],

191

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

192

},

193

],

194

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

Sai Cheemalapati

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

[diff] [blame]

201

202

Args:

203

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

Dan O'Meara

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

[diff] [blame]

204

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

205

The object takes the form of:

206

207

{

Bu Sun Kim

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

[diff] [blame^]

208

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

209

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

210

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

Sai Cheemalapati

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

[diff] [blame]

},

}

Bu Sun Kim

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

[diff] [blame]

214

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.

215

216

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.

217

218

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-03-13 12:12:03 -0400

[diff] [blame]

219

220

Returns:

221

An object of the form:

222

Bu Sun Kim

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

[diff] [blame]

223

{ # Represents an Operation resource.

224

#

Dan O'Meara

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

[diff] [blame]

225

# Google Compute Engine has three Operation resources:

226

#

227

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

228

#

Bu Sun Kim

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

[diff] [blame]

229

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

230

#

231

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

232

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

233

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

234

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

Bu Sun Kim

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

[diff] [blame]

235

#

Dan O'Meara

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

[diff] [blame]

236

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

Bu Sun Kim

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

[diff] [blame^]

237

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

238

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

239

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

240

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

241

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

242

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

Sai Cheemalapati

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

[diff] [blame]

243

{

Bu Sun Kim

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

[diff] [blame^]

244

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

245

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

246

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

Sai Cheemalapati

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

[diff] [blame]

247

},

248

],

249

},

Bu Sun Kim

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

[diff] [blame^]

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

{

268

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

269

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

270

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

271

{

272

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

273

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

274

},

275

],

276

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

277

},

278

],

279

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

284

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

285

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

Sai Cheemalapati

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

[diff] [blame]

286

287

Args:

288

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

Bu Sun Kim

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

[diff] [blame]

289

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.

290

291

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.

292

293

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-03-13 12:12:03 -0400

[diff] [blame]

294

295

Returns:

296

An object of the form:

297

Bu Sun Kim

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

[diff] [blame]

298

{ # Represents an Operation resource.

299

#

Dan O'Meara

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

[diff] [blame]

300

# Google Compute Engine has three Operation resources:

301

#

302

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

303

#

Bu Sun Kim

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

[diff] [blame]

304

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

305

#

306

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

307

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

308

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

309

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

Bu Sun Kim

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

[diff] [blame]

310

#

Dan O'Meara

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

[diff] [blame]

311

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

Bu Sun Kim

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

[diff] [blame^]

312

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

313

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

314

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

315

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

316

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

317

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

Sai Cheemalapati

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

[diff] [blame]

318

{

Bu Sun Kim

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

[diff] [blame^]

319

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

320

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

321

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

Sai Cheemalapati

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

[diff] [blame]

322

},

323

],

324

},

Bu Sun Kim

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

[diff] [blame^]

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

{

343

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

344

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

345

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

346

{

347

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

348

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

349

},

350

],

351

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

352

},

353

],

354

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

359

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

Bu Sun Kim

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

[diff] [blame]

360

<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-03-13 12:12:03 -0400

[diff] [blame]

361

362

Args:

363

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

Dan O'Meara

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

[diff] [blame]

364

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

365

The object takes the form of:

366

367

{

Bu Sun Kim

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

[diff] [blame^]

368

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

369

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

370

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

Sai Cheemalapati

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

[diff] [blame]

},

}

Bu Sun Kim

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

[diff] [blame]

374

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.

375

376

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.

377

378

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-03-13 12:12:03 -0400

[diff] [blame]

379

380

Returns:

381

An object of the form:

382

Bu Sun Kim

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

[diff] [blame]

383

{ # Represents an Operation resource.

384

#

Dan O'Meara

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

[diff] [blame]

385

# Google Compute Engine has three Operation resources:

386

#

387

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

388

#

Bu Sun Kim

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

[diff] [blame]

389

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

390

#

391

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

392

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

393

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

394

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

Bu Sun Kim

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

[diff] [blame]

395

#

Dan O'Meara

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

[diff] [blame]

396

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

Bu Sun Kim

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

[diff] [blame^]

397

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

398

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

399

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

400

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

401

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

402

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

Sai Cheemalapati

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

[diff] [blame]

403

{

Bu Sun Kim

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

[diff] [blame^]

404

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

405

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

406

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

Sai Cheemalapati

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

[diff] [blame]

407

},

408

],

409

},

Bu Sun Kim

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

[diff] [blame^]

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

{

428

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

429

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

430

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

431

{

432

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

433

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

434

},

435

],

436

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

437

},

438

],

439

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

444

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

445

<pre>Returns the specified Project resource.

446

447

Args:

448

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

449

450

Returns:

451

An object of the form:

452

Bu Sun Kim

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

[diff] [blame]

453

{ # Represents a Project resource.

454

#

Dan O'Meara

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

[diff] [blame]

455

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

Bu Sun Kim

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

[diff] [blame^]

456

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

457

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

458

#

459

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

460

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

461

{

462

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

463

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

464

},

465

],

466

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

Sai Cheemalapati

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

[diff] [blame]

467

},

Bu Sun Kim

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

[diff] [blame^]

468

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

469

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

470

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

471

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

472

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

473

"A String",

474

],

475

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

476

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

477

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

478

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

Sai Cheemalapati

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

[diff] [blame]

479

{ # A quotas entry.

Bu Sun Kim

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

[diff] [blame^]

480

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

481

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

482

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

483

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

Sai Cheemalapati

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

[diff] [blame]

484

},

485

],

Bu Sun Kim

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

[diff] [blame^]

486

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

487

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

488

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

489

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

490

},

Bu Sun Kim

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

[diff] [blame^]

491

"xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

496

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

Bu Sun Kim

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

[diff] [blame]

497

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

498

499

Args:

500

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

501

502

Returns:

503

An object of the form:

504

Bu Sun Kim

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

[diff] [blame]

505

{ # Represents a Project resource.

506

#

Dan O'Meara

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

[diff] [blame]

507

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

Bu Sun Kim

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

[diff] [blame^]

508

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

509

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

510

#

511

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

512

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

513

{

514

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

515

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

516

},

517

],

518

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

519

},

Bu Sun Kim

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

[diff] [blame^]

520

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

521

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

522

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

523

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

524

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

525

"A String",

526

],

527

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

528

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

529

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

530

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

531

{ # A quotas entry.

Bu Sun Kim

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

[diff] [blame^]

532

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

533

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

534

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

535

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

536

},

537

],

Bu Sun Kim

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

[diff] [blame^]

538

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

539

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

540

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

541

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

542

},

Bu Sun Kim

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

[diff] [blame^]

543

"xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

548

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

Bu Sun Kim

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

[diff] [blame]

549

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

Sai Cheemalapati

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

[diff] [blame]

550

551

Args:

552

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

Dan O'Meara

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

[diff] [blame]

553

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]

554

Dan O'Meara

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

[diff] [blame]

555

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]

556

Dan O'Meara

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

[diff] [blame]

557

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]

558

Bu Sun Kim

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

[diff] [blame^]

559

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

560

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

561

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

562

563

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.

564

565

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

566

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.

Sai Cheemalapati

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

[diff] [blame]

567

568

Returns:

569

An object of the form:

570

571

{

Bu Sun Kim

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

[diff] [blame^]

572

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

573

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

574

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

Bu Sun Kim

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

[diff] [blame]

575

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

Bu Sun Kim

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

[diff] [blame^]

576

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

577

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

Sai Cheemalapati

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

[diff] [blame]

},

],

}</pre>

</div>

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

585

<pre>Retrieves the next page of results.

586

587

Args:

588

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

589

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

590

591

Returns:

Bu Sun Kim

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

[diff] [blame^]

592

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

Sai Cheemalapati

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

[diff] [blame]

593

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

</pre>

</div>

Bu Sun Kim

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

[diff] [blame^]

598

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

Bu Sun Kim

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

[diff] [blame]

599

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

600

601

Args:

602

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

Dan O'Meara

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

[diff] [blame]

603

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

604

The object takes the form of:

605

606

{

Bu Sun Kim

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

[diff] [blame^]

607

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

608

}

609

Dan O'Meara

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

[diff] [blame]

610

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]

611

Dan O'Meara

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

[diff] [blame]

612

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]

613

Dan O'Meara

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

[diff] [blame]

614

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]

615

Bu Sun Kim

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

[diff] [blame^]

616

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

617

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

618

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

619

620

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.

621

622

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

623

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.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

624

625

Returns:

626

An object of the form:

627

628

{

Bu Sun Kim

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

[diff] [blame^]

629

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

630

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

Bu Sun Kim

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

[diff] [blame]

631

{ # Represents a Project resource.

632

#

Dan O'Meara

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

[diff] [blame]

633

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

Bu Sun Kim

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

[diff] [blame^]

634

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

635

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

636

#

637

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

638

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

639

{

640

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

641

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

642

},

643

],

644

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

645

},

Bu Sun Kim

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

[diff] [blame^]

646

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

647

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

648

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

649

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

650

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

651

"A String",

652

],

653

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

654

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

655

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

656

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

657

{ # A quotas entry.

Bu Sun Kim

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

[diff] [blame^]

658

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

659

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

660

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

661

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

662

},

663

],

Bu Sun Kim

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

[diff] [blame^]

664

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

665

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

666

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

667

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

668

},

Bu Sun Kim

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

[diff] [blame^]

669

"xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

670

},

671

],

Bu Sun Kim

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

[diff] [blame^]

672

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

673

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

674

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

675

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

676

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

677

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

678

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

Bu Sun Kim

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

[diff] [blame]

679

{

Bu Sun Kim

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

[diff] [blame^]

680

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

681

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

Bu Sun Kim

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

[diff] [blame]

682

},

683

],

Bu Sun Kim

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

[diff] [blame^]

684

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

Bu Sun Kim

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

[diff] [blame]

685

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

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

[diff] [blame]

690

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

691

<pre>Retrieves the next page of results.

692

693

Args:

694

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

695

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

696

697

Returns:

Bu Sun Kim

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

[diff] [blame^]

698

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

Sai Cheemalapati

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

[diff] [blame]

699

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]

704

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

Sai Cheemalapati

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

[diff] [blame]

705

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

706

707

Args:

708

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

Dan O'Meara

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

[diff] [blame]

709

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

710

The object takes the form of:

711

712

{

Bu Sun Kim

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

[diff] [blame^]

713

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

Sai Cheemalapati

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

[diff] [blame]

714

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

715

# - projects/project/zones/zone

716

# - zones/zone

Bu Sun Kim

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

[diff] [blame^]

717

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

718

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

719

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

720

# - zones/zone/disks/disk

Sai Cheemalapati

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

[diff] [blame]

721

}

722

Bu Sun Kim

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

[diff] [blame]

723

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.

724

725

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.

726

727

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

Sai Cheemalapati

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

[diff] [blame]

728

729

Returns:

730

An object of the form:

731

Bu Sun Kim

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

[diff] [blame]

732

{ # Represents an Operation resource.

733

#

Dan O'Meara

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

[diff] [blame]

734

# Google Compute Engine has three Operation resources:

735

#

736

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

737

#

Bu Sun Kim

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

[diff] [blame]

738

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

739

#

740

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

741

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

742

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

743

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

Bu Sun Kim

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

[diff] [blame]

744

#

Dan O'Meara

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

[diff] [blame]

745

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

Bu Sun Kim

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

[diff] [blame^]

746

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

747

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

748

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

749

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

750

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

751

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

Sai Cheemalapati

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

[diff] [blame]

752

{

Bu Sun Kim

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

[diff] [blame^]

753

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

754

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

755

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

Sai Cheemalapati

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

[diff] [blame]

756

},

757

],

758

},

Bu Sun Kim

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

[diff] [blame^]

759

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

760

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

761

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

762

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

763

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

764

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

765

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

766

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

767

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

768

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

769

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

770

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

771

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

772

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

773

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

774

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

775

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

776

{

777

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

778

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

779

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

780

{

781

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

782

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

783

},

784

],

785

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

786

},

787

],

788

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

793

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

Sai Cheemalapati

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

[diff] [blame]

794

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

795

796

Args:

797

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

Dan O'Meara

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

[diff] [blame]

798

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

799

The object takes the form of:

800

801

{

Bu Sun Kim

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

[diff] [blame^]

802

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

Sai Cheemalapati

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

[diff] [blame]

803

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

804

# - projects/project/zones/zone

805

# - zones/zone

Bu Sun Kim

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

[diff] [blame^]

806

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

807

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

808

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

809

# - zones/zone/instances/instance

Sai Cheemalapati

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

[diff] [blame]

810

}

811

Bu Sun Kim

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

[diff] [blame]

812

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.

813

814

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.

815

816

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

Sai Cheemalapati

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

[diff] [blame]

817

818

Returns:

819

An object of the form:

820

Bu Sun Kim

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

[diff] [blame]

821

{ # Represents an Operation resource.

822

#

Dan O'Meara

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

[diff] [blame]

823

# Google Compute Engine has three Operation resources:

824

#

825

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

826

#

Bu Sun Kim

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

[diff] [blame]

827

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

828

#

829

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

830

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

831

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

832

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

Bu Sun Kim

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

[diff] [blame]

833

#

Dan O'Meara

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

[diff] [blame]

834

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

Bu Sun Kim

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

[diff] [blame^]

835

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

836

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

837

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

838

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

839

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

840

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

Sai Cheemalapati

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

[diff] [blame]

841

{

Bu Sun Kim

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

[diff] [blame^]

842

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

843

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

844

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

Sai Cheemalapati

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

[diff] [blame]

845

},

846

],

847

},

Bu Sun Kim

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

[diff] [blame^]

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

{

866

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

867

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

868

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

869

{

870

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

871

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

872

},

873

],

874

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

875

},

876

],

877

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

882

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

Sai Cheemalapati

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

[diff] [blame]

883

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

884

885

Args:

886

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

Dan O'Meara

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

[diff] [blame]

887

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

888

The object takes the form of:

889

890

{ # A metadata key/value entry.

Bu Sun Kim

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

[diff] [blame^]

891

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

892

#

893

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

894

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

895

{

896

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

897

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

898

},

899

],

900

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

Sai Cheemalapati

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

[diff] [blame]

901

}

902

Bu Sun Kim

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

[diff] [blame]

903

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.

904

905

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.

906

907

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

Sai Cheemalapati

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

[diff] [blame]

908

909

Returns:

910

An object of the form:

911

Bu Sun Kim

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

[diff] [blame]

912

{ # Represents an Operation resource.

913

#

Dan O'Meara

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

[diff] [blame]

914

# Google Compute Engine has three Operation resources:

915

#

916

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

917

#

Bu Sun Kim

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

[diff] [blame]

918

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

919

#

920

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

921

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

922

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

923

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

Bu Sun Kim

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

[diff] [blame]

924

#

Dan O'Meara

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

[diff] [blame]

925

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

Bu Sun Kim

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

[diff] [blame^]

926

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

927

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

928

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

929

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

930

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

931

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

Sai Cheemalapati

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

[diff] [blame]

932

{

Bu Sun Kim

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

[diff] [blame^]

933

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

934

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

935

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

Sai Cheemalapati

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

[diff] [blame]

936

},

937

],

938

},

Bu Sun Kim

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

[diff] [blame^]

939

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

940

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

941

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

942

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

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

{

957

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

958

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

959

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

960

{

961

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

962

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

963

},

964

],

965

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

966

},

967

],

968

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

973

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

Bu Sun Kim

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

[diff] [blame]

974

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

975

976

Args:

977

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

Dan O'Meara

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

[diff] [blame]

978

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

979

The object takes the form of:

980

981

{

Bu Sun Kim

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

[diff] [blame^]

982

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

Bu Sun Kim

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

[diff] [blame]

983

}

984

985

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.

986

987

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.

988

989

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

990

991

Returns:

992

An object of the form:

993

994

{ # Represents an Operation resource.

995

#

Dan O'Meara

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

[diff] [blame]

996

# Google Compute Engine has three Operation resources:

997

#

998

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

999

#

Bu Sun Kim

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

[diff] [blame]

1000

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

1001

#

1002

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1003

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

1004

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

1005

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

Bu Sun Kim

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

[diff] [blame]

1006

#

Dan O'Meara

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

[diff] [blame]

1007

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

Bu Sun Kim

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

[diff] [blame^]

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

Bu Sun Kim

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

[diff] [blame]

1014

{

Bu Sun Kim

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

[diff] [blame^]

1015

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

1016

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

1017

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

Bu Sun Kim

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

[diff] [blame]

1018

},

1019

],

1020

},

Bu Sun Kim

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

[diff] [blame^]

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

{

1039

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

1040

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

1041

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

1042

{

1043

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

1044

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

1045

},

1046

],

1047

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

1048

},

1049

],

1050

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1055

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

Sai Cheemalapati

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

[diff] [blame]

1056

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

1057

1058

Args:

1059

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

Dan O'Meara

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

[diff] [blame]

1060

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

1061

The object takes the form of:

1062

1063

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

1064

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

1065

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1066

}

Sai Cheemalapati

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

[diff] [blame]

1067

Bu Sun Kim

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

[diff] [blame]

1068

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.

1069

1070

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.

1071

1072

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

Sai Cheemalapati

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

[diff] [blame]

1073

1074

Returns:

1075

An object of the form:

1076

Bu Sun Kim

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

[diff] [blame]

1077

{ # Represents an Operation resource.

1078

#

Dan O'Meara

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

[diff] [blame]

1079

# Google Compute Engine has three Operation resources:

1080

#

1081

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

1082

#

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

#

1085

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1086

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

1087

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

1088

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

Bu Sun Kim

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

[diff] [blame]

1089

#

Dan O'Meara

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

[diff] [blame]

1090

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

Bu Sun Kim

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

[diff] [blame^]

1091

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

1092

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

1093

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

1094

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

1095

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

1096

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

Sai Cheemalapati

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

[diff] [blame]

1097

{

Bu Sun Kim

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

[diff] [blame^]

1098

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

1099

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

1100

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

Sai Cheemalapati

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

[diff] [blame]

1101

},

1102

],

1103

},

Bu Sun Kim