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

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

[diff] [blame]

84

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

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">Retrieves aggregated list of all of the instances in your project across all regions and zones.</p>

Sai Cheemalapati

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

[diff] [blame]

86

87

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

88

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

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

91

<p class="firstline">Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.</p>

Sai Cheemalapati

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

[diff] [blame]

92

yoshi-code-bot

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

[diff] [blame]

93

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

94

<p class="firstline">Creates multiple instances. Count specifies the number of instances to create.</p>

95

Dmitry Frenkel

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

[diff] [blame]

96

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

97

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

98

Bu Sun Kim

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

[diff] [blame]

99

<code><a href="#delete">delete(project, zone, instance, requestId=None)</a></code></p>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

100

<p class="firstline">Deletes the specified Instance resource. For more information, see Deleting an instance.</p>

Sai Cheemalapati

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

[diff] [blame]

101

Bu Sun Kim

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

[diff] [blame]

102

<code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

103

<p class="firstline">Deletes an access config from an instance's network interface.</p>

104

Bu Sun Kim

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

[diff] [blame]

105

<code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

106

<p class="firstline">Detaches a disk from an instance.</p>

107

108

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

Bu Sun Kim

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

[diff] [blame]

109

<p class="firstline">Returns the specified Instance resource. Gets a list of available instances by making a list() request.</p>

110

Dan O'Meara

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

[diff] [blame]

111

<code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</a></code></p>

112

<p class="firstline">Returns effective firewalls applied to an interface of the instance.</p>

113

Bu Sun Kim

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

[diff] [blame]

114

<code><a href="#getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

115

<p class="firstline">Returns the specified guest attributes entry.</p>

116

Dan O'Meara

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

[diff] [blame]

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

Sai Cheemalapati

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

[diff] [blame]

119

Dan O'Meara

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

[diff] [blame]

120

<code><a href="#getScreenshot">getScreenshot(project, zone, instance)</a></code></p>

121

<p class="firstline">Returns the screenshot from the specified instance.</p>

122

Bu Sun Kim

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

[diff] [blame]

123

<code><a href="#getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

124

<p class="firstline">Returns the last 1 MB of serial port output from the specified instance.</p>

Sai Cheemalapati

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

[diff] [blame]

125

Bu Sun Kim

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

[diff] [blame]

126

<code><a href="#getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</a></code></p>

127

<p class="firstline">Returns the Shielded Instance Identity of an instance</p>

128

129

<code><a href="#getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</a></code></p>

130

<p class="firstline">Returns the Shielded VM Identity of an instance</p>

131

Bu Sun Kim

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

[diff] [blame]

132

<code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

133

<p class="firstline">Creates an instance resource in the specified project using the data included in the request.</p>

134

Dmitry Frenkel

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

[diff] [blame]

135

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

Sai Cheemalapati

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

[diff] [blame]

136

<p class="firstline">Retrieves the list of instances contained within the specified zone.</p>

137

Dmitry Frenkel

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

[diff] [blame]

138

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

Bu Sun Kim

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

[diff] [blame]

139

<p class="firstline">Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.</p>

Sai Cheemalapati

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

[diff] [blame]

140

141

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

142

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

143

Sai Cheemalapati

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

[diff] [blame]

144

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

145

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

146

Dan O'Meara

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

[diff] [blame]

147

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

148

<p class="firstline">Removes resource policies from an instance.</p>

149

Bu Sun Kim

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

[diff] [blame]

150

<code><a href="#reset">reset(project, zone, instance, requestId=None)</a></code></p>

151

<p class="firstline">Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.</p>

Sai Cheemalapati

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

[diff] [blame]

152

Dan O'Meara

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

[diff] [blame]

153

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

Bu Sun Kim

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

[diff] [blame]

154

<p class="firstline">Resumes an instance that was suspended using the instances().suspend method.</p>

155

156

<code><a href="#setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</a></code></p>

157

<p class="firstline">Sets deletion protection on the instance.</p>

158

159

<code><a href="#setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

160

<p class="firstline">Sets the auto-delete flag for a disk attached to an instance.</p>

161

Dan O'Meara

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

[diff] [blame]

162

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

Bu Sun Kim

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

[diff] [blame]

163

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

Sai Cheemalapati

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

[diff] [blame]

164

Dan O'Meara

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

[diff] [blame]

165

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

Bu Sun Kim

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

[diff] [blame]

166

<p class="firstline">Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.</p>

167

Dan O'Meara

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

[diff] [blame]

168

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

Sai Cheemalapati

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

[diff] [blame]

169

<p class="firstline">Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.</p>

170

Dan O'Meara

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

[diff] [blame]

171

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

Sai Cheemalapati

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

[diff] [blame]

172

<p class="firstline">Changes the machine type for a stopped instance to the machine type specified in the request.</p>

173

Dan O'Meara

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

[diff] [blame]

174

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

Sai Cheemalapati

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

[diff] [blame]

175

<p class="firstline">Sets metadata for the specified instance to the data included in the request.</p>

176

Dan O'Meara

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

[diff] [blame]

177

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

Bu Sun Kim

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

[diff] [blame]

178

<p class="firstline">Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.</p>

Sai Cheemalapati

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

[diff] [blame]

179

Dmitry Frenkel

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

[diff] [blame]

180

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

181

<p class="firstline">Sets name of an instance.</p>

182

Dan O'Meara

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

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

<p class="firstline">Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.</p>

Sai Cheemalapati

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

[diff] [blame]

185

Dan O'Meara

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

[diff] [blame]

186

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

Sai Cheemalapati

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

[diff] [blame]

187

<p class="firstline">Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.</p>

Jon Wayne Parrott

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

[diff] [blame]

188

Dan O'Meara

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

[diff] [blame]

189

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

Bu Sun Kim

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

[diff] [blame]

190

<p class="firstline">Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

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

[diff] [blame]

191

Dan O'Meara

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

[diff] [blame]

192

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

Bu Sun Kim

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

[diff] [blame]

193

<p class="firstline">Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

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

[diff] [blame]

194

Dan O'Meara

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

[diff] [blame]

195

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

Bu Sun Kim

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

[diff] [blame]

196

<p class="firstline">Sets network tags for the specified instance to the data included in the request.</p>

Sai Cheemalapati

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

[diff] [blame]

197

Bu Sun Kim

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

[diff] [blame]

198

<code><a href="#simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</a></code></p>

199

<p class="firstline">Simulates a maintenance event on the instance.</p>

200

201

<code><a href="#start">start(project, zone, instance, requestId=None)</a></code></p>

202

<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p>

203

Dan O'Meara

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

[diff] [blame]

204

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

Bu Sun Kim

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

[diff] [blame]

205

<p class="firstline">Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.</p>

206

207

<code><a href="#stop">stop(project, zone, instance, requestId=None)</a></code></p>

208

<p class="firstline">Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.</p>

209

210

<code><a href="#suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</a></code></p>

211

<p class="firstline">This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.</p>

Sai Cheemalapati

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

[diff] [blame]

212

Dan O'Meara

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

[diff] [blame]

213

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

Sai Cheemalapati

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

[diff] [blame]

214

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

Bu Sun Kim

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

[diff] [blame]

215

Bu Sun Kim

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

[diff] [blame]

216

<code><a href="#update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None)</a></code></p>

Dan O'Meara

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

[diff] [blame]

217

<p class="firstline">Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.</p>

218

219

<code><a href="#updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

220

<p class="firstline">Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

221

Dan O'Meara

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

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame]

223

<p class="firstline">Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

224

Dan O'Meara

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

[diff] [blame]

225

<code><a href="#updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None)</a></code></p>

yoshi-code-bot

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

[diff] [blame]

226

<p class="firstline">Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.</p>

Bu Sun Kim

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

[diff] [blame]

227

Dan O'Meara

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

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

<p class="firstline">Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

230

Dan O'Meara

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

[diff] [blame]

231

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

Bu Sun Kim

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

[diff] [blame]

232

<p class="firstline">Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Sai Cheemalapati

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

[diff] [blame]

233

<h3>Method Details</h3>

234

Dan O'Meara

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

[diff] [blame]

235

<code class="details" id="addAccessConfig">addAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

236

<pre>Adds an access config to an instance's network interface.

Sai Cheemalapati

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

[diff] [blame]

237

238

Args:

239

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

240

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

241

instance: string, The instance name for this request. (required)

242

networkInterface: string, The name of the network interface to add to this instance. (required)

Dan O'Meara

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

[diff] [blame]

243

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

244

The object takes the form of:

245

Bu Sun Kim

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

[diff] [blame]

246

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

247

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

248

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

249

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

250

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

Bu Sun Kim

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

[diff] [blame]

251

#

252

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

253

#

254

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Bu Sun Kim

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

[diff] [blame]

255

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

256

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

257

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Sai Cheemalapati

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

[diff] [blame]

258

}

259

Bu Sun Kim

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

[diff] [blame]

260

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.

261

262

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.

263

264

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]

265

266

Returns:

267

An object of the form:

268

Bu Sun Kim

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

[diff] [blame]

269

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

270

#

271

# Google Compute Engine has three Operation resources:

272

#

273

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

274

#

275

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

276

#

277

# Operations can be global, regional or zonal.

278

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

279

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

280

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

281

#

282

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

283

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

284

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

285

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

286

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

287

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

288

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

Bu Sun Kim

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

[diff] [blame]

289

{

Yoshi Automation Bot

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

[diff] [blame]

290

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

291

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

292

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

Bu Sun Kim

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

[diff] [blame]

293

},

294

],

Yoshi Automation Bot

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

[diff] [blame]

295

},

296

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

297

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

298

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

299

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

300

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

301

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

yoshi-code-bot

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

[diff] [blame]

302

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

Yoshi Automation Bot

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

[diff] [blame]

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

{

315

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

316

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

317

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

318

{

319

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

320

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

321

},

322

],

323

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

324

},

325

],

326

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

327

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

331

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

332

<pre>Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.

333

334

Args:

335

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

336

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

337

instance: string, The instance name for this request. (required)

338

body: object, The request body.

339

The object takes the form of:

340

341

{

Yoshi Automation Bot

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

[diff] [blame]

342

"resourcePolicies": [ # Resource policies to be added to this instance.

343

"A String",

344

],

345

}

Dan O'Meara

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

[diff] [blame]

346

347

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.

348

349

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.

350

351

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

352

353

Returns:

354

An object of the form:

355

356

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

357

#

358

# Google Compute Engine has three Operation resources:

359

#

360

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

361

#

362

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

363

#

364

# Operations can be global, regional or zonal.

365

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

366

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

367

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

368

#

369

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

370

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

371

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

372

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

373

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

374

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

375

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

Bu Sun Kim

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

[diff] [blame]

376

{

Yoshi Automation Bot

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

[diff] [blame]

377

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

378

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

379

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

Bu Sun Kim

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

[diff] [blame]

380

},

381

],

Yoshi Automation Bot

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

[diff] [blame]

382

},

383

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

384

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

385

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

386

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

387

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

388

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

yoshi-code-bot

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

[diff] [blame]

389

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

Yoshi Automation Bot

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

[diff] [blame]

390

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

391

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

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

{

402

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

403

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

404

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

405

{

406

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

407

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

408

},

409

],

410

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

411

},

412

],

413

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

414

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

418

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

Bu Sun Kim

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

[diff] [blame]

419

<pre>Retrieves aggregated list of all of the instances in your project across all regions and zones.

Sai Cheemalapati

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

[diff] [blame]

420

421

Args:

422

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

Dan O'Meara

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

[diff] [blame]

423

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

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

[diff] [blame]

424

Dan O'Meara

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

[diff] [blame]

425

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

Sai Cheemalapati

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

[diff] [blame]

426

Dan O'Meara

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

[diff] [blame]

427

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

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

[diff] [blame]

428

Bu Sun Kim

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

[diff] [blame]

429

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

Dan O'Meara

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

[diff] [blame]

430

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame]

431

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

432

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

433

434

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.

435

436

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

437

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

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

[diff] [blame]

438

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

Sai Cheemalapati

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

[diff] [blame]

439

440

Returns:

441

An object of the form:

442

443

{

Yoshi Automation Bot

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

[diff] [blame]

444

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

445

"items": { # An object that contains a list of instances scoped by zone.

446

"a_key": { # [Output Only] Name of the scope containing this set of instances.

447

"instances": [ # [Output Only] A list of instances contained in this scope.

448

{ # Represents an Instance resource.

449

#

450

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

yoshi-code-bot

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

[diff] [blame]

451

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

452

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

453

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

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

[diff] [blame]

454

},

Yoshi Automation Bot

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

[diff] [blame]

455

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

456

"confidentialInstanceConfig": { # A set of Confidential Instance options.

457

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

458

},

459

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

460

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

461

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

462

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

463

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

464

{ # An instance-attached disk resource.

465

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

466

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

467

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

468

#

469

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

470

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

471

#

472

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

473

#

474

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

475

#

476

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

477

#

478

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

479

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

480

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

481

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

482

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

483

#

Yoshi Automation Bot

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

[diff] [blame]

484

# The key must meet the following requirements before you can provide it to Compute Engine:

485

# - The key is wrapped using a RSA public key certificate provided by Google.

486

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

487

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

488

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

489

},

490

"diskSizeGb": "A String", # The size of the disk in GB.

491

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

492

{ # Guest OS features.

493

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

494

},

495

],

496

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

497

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

498

#

499

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

500

#

501

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

502

"description": "A String", # An optional description. Provide this property when creating the disk.

503

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

504

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

505

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

506

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

Sai Cheemalapati

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

[diff] [blame]

507

#

Sai Cheemalapati

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

[diff] [blame]

508

#

Yoshi Automation Bot

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

[diff] [blame]

509

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

510

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

511

# - projects/project/zones/zone/diskTypes/diskType

512

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

513

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Sai Cheemalapati

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

[diff] [blame]

514

#

Yoshi Automation Bot

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

[diff] [blame]

515

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

516

{ # Guest OS features.

517

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

518

},

519

],

520

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

521

"a_key": "A String",

522

},

523

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

524

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

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

[diff] [blame]

525

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

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

[diff] [blame]

526

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

527

"A String",

528

],

529

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

530

#

Yoshi Automation Bot

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

[diff] [blame]

531

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

532

# projects/debian-cloud/global/images/family/debian-9

533

#

534

#

535

# Alternatively, use a specific version of a public operating system image:

536

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

537

#

538

#

539

# To create a disk with a custom image that you created, specify the image name in the following format:

540

# global/images/my-custom-image

541

#

542

#

543

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

544

# global/images/family/my-image-family

545

#

546

#

547

# If the source image is deleted later, this field will not be set.

548

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

549

#

550

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

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

[diff] [blame]

551

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

552

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

553

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

554

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

555

#

556

# The key must meet the following requirements before you can provide it to Compute Engine:

557

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

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

[diff] [blame]

558

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

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

[diff] [blame]

559

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

560

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

561

},

Yoshi Automation Bot

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

[diff] [blame]

562

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

563

#

Yoshi Automation Bot

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

[diff] [blame]

564

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

565

# global/snapshots/my-backup

Sai Cheemalapati

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

[diff] [blame]

566

#

Yoshi Automation Bot

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

[diff] [blame]

567

#

568

# If the source snapshot is deleted later, this field will not be set.

569

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

570

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

571

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

572

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

573

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

574

#

Yoshi Automation Bot

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

[diff] [blame]

575

# The key must meet the following requirements before you can provide it to Compute Engine:

576

# - The key is wrapped using a RSA public key certificate provided by Google.

577

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

578

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

579

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

580

},

Yoshi Automation Bot

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

[diff] [blame]

581

},

582

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

583

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

584

"licenses": [ # [Output Only] Any valid publicly visible licenses.

585

"A String",

586

],

587

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

588

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

589

"dbs": [ # The Key Database (db).

590

{

Bu Sun Kim

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

[diff] [blame]

591

"content": "A String", # The raw content in the secure keys file.

592

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

593

},

Yoshi Automation Bot

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

[diff] [blame]

594

],

595

"dbxs": [ # The forbidden key database (dbx).

596

{

597

"content": "A String", # The raw content in the secure keys file.

598

"fileType": "A String", # The file type of source file.

599

},

600

],

601

"keks": [ # The Key Exchange Key (KEK).

602

{

603

"content": "A String", # The raw content in the secure keys file.

604

"fileType": "A String", # The file type of source file.

605

},

606

],

607

"pk": { # The Platform Key (PK).

608

"content": "A String", # The raw content in the secure keys file.

609

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

610

},

Sai Cheemalapati

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

[diff] [blame]

611

},

Yoshi Automation Bot

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

[diff] [blame]

612

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Bu Sun Kim

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

[diff] [blame]

613

#

Yoshi Automation Bot

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

[diff] [blame]

614

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

615

#

616

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

617

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

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

[diff] [blame]

618

},

Yoshi Automation Bot

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

[diff] [blame]

619

],

620

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

621

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

622

},

623

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

624

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

625

#

626

# To see the latest fingerprint, make get() request to the instance.

627

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

628

{ # A specification of the type and number of accelerator cards attached to the instance.

629

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

630

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

631

},

632

],

633

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

634

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

635

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

636

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

637

#

638

# To see the latest fingerprint, make get() request to the instance.

639

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

640

"a_key": "A String",

641

},

642

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

643

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

644

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

645

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

646

# zones/us-central1-f/machineTypes/n1-standard-1

647

#

648

#

649

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

650

# zones/zone/machineTypes/custom-CPUS-MEMORY

651

#

652

#

653

# For example: zones/us-central1-f/machineTypes/custom-4-5120

654

#

655

# For a full list of restrictions, read the Specifications for custom machine types.

656

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

657

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

658

#

659

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

660

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

661

{

662

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

663

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

Bu Sun Kim

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

[diff] [blame]

664

},

665

],

Yoshi Automation Bot

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

[diff] [blame]

666

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

667

},

668

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

669

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

670

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

671

{ # A network interface resource attached to an instance.

672

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

673

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

674

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

675

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

676

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

677

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

678

#

679

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

680

#

681

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

682

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

683

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

684

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

685

},

Bu Sun Kim

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

[diff] [blame]

686

],

Yoshi Automation Bot

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

[diff] [blame]

687

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

688

{ # An alias IP range attached to an instance's network interface.

689

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

690

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

691

},

692

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

693

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

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

[diff] [blame]

694

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

695

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

696

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

697

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

698

#

699

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

700

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

701

# - projects/project/global/networks/network

702

# - global/networks/default

703

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

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

[diff] [blame]

704

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Yoshi Automation Bot

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

[diff] [blame]

705

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

706

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

707

# - regions/region/subnetworks/subnetwork

Bu Sun Kim

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

[diff] [blame]

708

},

Yoshi Automation Bot

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

[diff] [blame]

709

],

yoshi-code-bot

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

[diff] [blame]

710

"networkPerformanceConfig": {

711

"totalEgressBandwidthTier": "A String",

712

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

713

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Yoshi Automation Bot

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

[diff] [blame]

714

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

715

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

716

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

717

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

718

"values": [ # Corresponds to the label values of a reservation resource.

Bu Sun Kim

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

[diff] [blame]

719

"A String",

720

],

Yoshi Automation Bot

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

[diff] [blame]

721

},

722

"resourcePolicies": [ # Resource policies applied to this instance.

723

"A String",

724

],

yoshi-code-bot

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

[diff] [blame]

725

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

726

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Yoshi Automation Bot

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

[diff] [blame]

727

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

Bu Sun Kim

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

[diff] [blame]

728

#

Yoshi Automation Bot

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

[diff] [blame]

729

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

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

[diff] [blame]

730

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

731

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

732

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

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

[diff] [blame]

733

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

734

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

735

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

736

"key": "A String", # Corresponds to the label key of Node resource.

737

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

738

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

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

[diff] [blame]

743

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

744

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

745

},

746

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

747

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

748

#

749

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

750

{ # A service account.

751

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

752

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

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

[diff] [blame]

753

"A String",

754

],

755

},

Sai Cheemalapati

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

[diff] [blame]

756

],

Yoshi Automation Bot

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

[diff] [blame]

757

"shieldedInstanceConfig": { # A set of Shielded Instance options.

758

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

759

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

760

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

761

},

762

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

763

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

764

},

765

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

766

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

767

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

768

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

769

},

770

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

771

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

772

},

773

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

774

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Yoshi Automation Bot

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

[diff] [blame]

775

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

776

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

777

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

778

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

779

#

780

# The key must meet the following requirements before you can provide it to Compute Engine:

781

# - The key is wrapped using a RSA public key certificate provided by Google.

782

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

783

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

784

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

785

},

786

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

787

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

788

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

789

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

790

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

791

#

792

# To see the latest fingerprint, make get() request to the instance.

793

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Bu Sun Kim

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

[diff] [blame]

798

},

799

],

Yoshi Automation Bot

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

[diff] [blame]

800

"warning": { # [Output Only] Informational warning which replaces the list of instances when the list is empty.

801

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

802

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

803

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

804

{

805

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

806

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

807

},

808

],

809

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

810

},

Bu Sun Kim

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

[diff] [blame]

811

},

Yoshi Automation Bot

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

[diff] [blame]

812

},

813

"kind": "compute#instanceAggregatedList", # [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.

814

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

815

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

816

"unreachables": [ # [Output Only] Unreachable resources.

817

"A String",

818

],

819

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

820

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

821

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

822

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

823

{

824

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

825

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

826

},

827

],

828

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

829

},

830

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

835

<pre>Retrieves the next page of results.

836

837

Args:

838

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

839

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

840

841

Returns:

Bu Sun Kim

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

[diff] [blame]

842

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

Sai Cheemalapati

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

[diff] [blame]

843

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]

848

<code class="details" id="attachDisk">attachDisk(project, zone, instance, body=None, forceAttach=None, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

849

<pre>Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.

Sai Cheemalapati

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

[diff] [blame]

850

851

Args:

852

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

853

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

854

instance: string, The instance name for this request. (required)

Dan O'Meara

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

[diff] [blame]

855

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

856

The object takes the form of:

857

858

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

859

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

860

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

861

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

862

#

863

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

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

[diff] [blame]

864

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

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

[diff] [blame]

865

#

866

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

867

#

868

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

869

#

870

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

871

#

872

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

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

[diff] [blame]

873

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

874

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

875

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

876

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

877

#

878

# The key must meet the following requirements before you can provide it to Compute Engine:

879

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

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

[diff] [blame]

880

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

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

[diff] [blame]

881

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

882

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

883

},

Bu Sun Kim

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

[diff] [blame]

884

"diskSizeGb": "A String", # The size of the disk in GB.

885

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

886

{ # Guest OS features.

887

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

888

},

889

],

890

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

891

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

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

[diff] [blame]

892

#

893

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

894

#

895

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

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

[diff] [blame]

896

"description": "A String", # An optional description. Provide this property when creating the disk.

897

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

898

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

899

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

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

[diff] [blame]

900

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

901

#

Bu Sun Kim

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

[diff] [blame]

902

#

Sai Cheemalapati

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

[diff] [blame]

903

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

904

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

905

# - projects/project/zones/zone/diskTypes/diskType

906

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

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

[diff] [blame]

907

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

908

#

909

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

910

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

911

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

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

[diff] [blame]

912

},

913

],

Bu Sun Kim

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

[diff] [blame]

914

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

915

"a_key": "A String",

916

},

Bu Sun Kim

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

[diff] [blame]

917

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

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

[diff] [blame]

918

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

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

[diff] [blame]

919

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

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

[diff] [blame]

920

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

921

"A String",

Bu Sun Kim

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

[diff] [blame]

922

],

Bu Sun Kim

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

[diff] [blame]

923

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

924

#

Bu Sun Kim

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

[diff] [blame]

925

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

926

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

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

[diff] [blame]

927

#

Sai Cheemalapati

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

[diff] [blame]

928

#

929

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

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

[diff] [blame]

930

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

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

[diff] [blame]

931

#

Sai Cheemalapati

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

[diff] [blame]

932

#

Bu Sun Kim

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

[diff] [blame]

933

# To create a disk with a custom image that you created, specify the image name in the following format:

934

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

935

#

Sai Cheemalapati

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

[diff] [blame]

936

#

Bu Sun Kim

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

[diff] [blame]

937

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

938

# global/images/family/my-image-family

Sai Cheemalapati

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

[diff] [blame]

939

#

Jon Wayne Parrott

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

[diff] [blame]

940

#

941

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

942

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

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

[diff] [blame]

943

#

944

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

945

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

946

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

947

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

948

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

949

#

950

# The key must meet the following requirements before you can provide it to Compute Engine:

951

# - The key is wrapped using a RSA public key certificate provided by Google.

952

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

953

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

954

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

955

},

956

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

957

#

958

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

959

# global/snapshots/my-backup

960

#

961

#

962

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

963

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

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

[diff] [blame]

964

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

965

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

966

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

967

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

968

#

969

# The key must meet the following requirements before you can provide it to Compute Engine:

970

# - The key is wrapped using a RSA public key certificate provided by Google.

971

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

972

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

973

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

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

[diff] [blame]

974

},

Sai Cheemalapati

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

[diff] [blame]

975

},

Bu Sun Kim

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

[diff] [blame]

976

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

977

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

978

"licenses": [ # [Output Only] Any valid publicly visible licenses.

979

"A String",

980

],

981

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

982

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

983

"dbs": [ # The Key Database (db).

Dan O'Meara

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

[diff] [blame]

984

{

Bu Sun Kim

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

[diff] [blame]

985

"content": "A String", # The raw content in the secure keys file.

986

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

987

},

988

],

Bu Sun Kim

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

[diff] [blame]

989

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

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

[diff] [blame]

990

{

Bu Sun Kim

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

[diff] [blame]

991

"content": "A String", # The raw content in the secure keys file.

992

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

993

},

994

],

Bu Sun Kim

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

[diff] [blame]

995

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

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

[diff] [blame]

996

{

Bu Sun Kim

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

[diff] [blame]

997

"content": "A String", # The raw content in the secure keys file.

998

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

999

},

1000

],

Bu Sun Kim

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

[diff] [blame]

1001

"pk": { # The Platform Key (PK).

1002

"content": "A String", # The raw content in the secure keys file.

1003

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1004

},

1005

},

Bu Sun Kim

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

[diff] [blame]

1006

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

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

[diff] [blame]

1007

#

1008

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1009

#

1010

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

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

[diff] [blame]

1011

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

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

[diff] [blame]

1012

}

1013

Dmitry Frenkel

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

[diff] [blame]

1014

forceAttach: boolean, Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

Bu Sun Kim

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

[diff] [blame]

1015

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.

1016

1017

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.

1018

1019

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]

1020

1021

Returns:

1022

An object of the form:

1023

Bu Sun Kim

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

[diff] [blame]

1024

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1025

#

1026

# Google Compute Engine has three Operation resources:

1027

#

1028

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

1029

#

1030

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

1031

#

1032

# Operations can be global, regional or zonal.

1033

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

1034

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

1035

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

1036

#

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

Bu Sun Kim

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

[diff] [blame]

1044

{

Yoshi Automation Bot

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

[diff] [blame]

1045

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

1046

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

1047

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

Bu Sun Kim

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

[diff] [blame]

1048

},

1049

],

Yoshi Automation Bot

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

[diff] [blame]

1050

},

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

yoshi-code-bot

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

[diff] [blame]

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

{

1070

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

1071

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

1072

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

1073

{

1074

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1075

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

1076

},

1077

],

1078

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

1079

},

1080

],

1081

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

}</pre>

</div>

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

1087

<pre>Creates multiple instances. Count specifies the number of instances to create.

1088

1089

Args:

1090

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

1091

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

1092

body: object, The request body.

1093

The object takes the form of:

1094

1095

{

1096

"count": "A String", # The maximum number of instances to create.

1097

"instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

1098

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

1099

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1100

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

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

[diff] [blame]

1101

},

1102

"canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.

1103

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

1104

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1105

},

1106

"description": "A String", # An optional text description for the instances that are created from these properties.

1107

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1108

{ # An instance-attached disk resource.

1109

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

1110

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

1111

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

1112

#

1113

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

1114

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

1115

#

1116

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

1117

#

1118

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

1119

#

1120

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

1121

#

1122

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

1123

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1124

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1125

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1126

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1127

#

1128

# The key must meet the following requirements before you can provide it to Compute Engine:

1129

# - The key is wrapped using a RSA public key certificate provided by Google.

1130

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1131

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1132

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1133

},

1134

"diskSizeGb": "A String", # The size of the disk in GB.

1135

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

1136

{ # Guest OS features.

1137

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1138

},

1139

],

1140

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

1141

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

1142

#

1143

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1144

#

1145

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1146

"description": "A String", # An optional description. Provide this property when creating the disk.

1147

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

1148

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

1149

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

1150

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

1151

#

1152

#

1153

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

1154

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

1155

# - projects/project/zones/zone/diskTypes/diskType

1156

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

1157

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

1158

#

1159

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1160

{ # Guest OS features.

1161

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1162

},

1163

],

1164

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

1165

"a_key": "A String",

1166

},

1167

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1168

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1169

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

1170

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

1171

"A String",

1172

],

1173

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

1174

#

1175

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

1176

# projects/debian-cloud/global/images/family/debian-9

1177

#

1178

#

1179

# Alternatively, use a specific version of a public operating system image:

1180

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1181

#

1182

#

1183

# To create a disk with a custom image that you created, specify the image name in the following format:

1184

# global/images/my-custom-image

1185

#

1186

#

1187

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

1188

# global/images/family/my-image-family

1189

#

1190

#

1191

# If the source image is deleted later, this field will not be set.

1192

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1193

#

1194

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

1195

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1196

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1197

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1198

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1199

#

1200

# The key must meet the following requirements before you can provide it to Compute Engine:

1201

# - The key is wrapped using a RSA public key certificate provided by Google.

1202

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1203

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1204

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1205

},

1206

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

1207

#

1208

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1209

# global/snapshots/my-backup

1210

#

1211

#

1212

# If the source snapshot is deleted later, this field will not be set.

1213

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1214

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1215

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1216

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1217

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1218

#

1219

# The key must meet the following requirements before you can provide it to Compute Engine:

1220

# - The key is wrapped using a RSA public key certificate provided by Google.

1221

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1222

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1223

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1224

},

1225

},

1226

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

1227

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

1228

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1229

"A String",

1230

],

1231

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

1232

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

1233

"dbs": [ # The Key Database (db).

1234

{

1235

"content": "A String", # The raw content in the secure keys file.

1236

"fileType": "A String", # The file type of source file.

1237

},

1238

],

1239

"dbxs": [ # The forbidden key database (dbx).

1240

{

1241

"content": "A String", # The raw content in the secure keys file.

1242

"fileType": "A String", # The file type of source file.

1243

},

1244

],

1245

"keks": [ # The Key Exchange Key (KEK).

1246

{

1247

"content": "A String", # The raw content in the secure keys file.

1248

"fileType": "A String", # The file type of source file.

1249

},

1250

],

1251

"pk": { # The Platform Key (PK).

1252

"content": "A String", # The raw content in the secure keys file.

1253

"fileType": "A String", # The file type of source file.

1254

},

1255

},

1256

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

1257

#

1258

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1259

#

1260

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1261

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

1262

},

1263

],

1264

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1265

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1266

},

1267

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1268

{ # A specification of the type and number of accelerator cards attached to the instance.

1269

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1270

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

1271

},

1272

],

1273

"labels": { # Labels to apply to instances that are created from these properties.

1274

"a_key": "A String",

1275

},

1276

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1277

"metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.

1278

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

1279

#

1280

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

1281

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

1282

{

1283

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

1284

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

1285

},

1286

],

1287

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

1288

},

1289

"minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform.

1290

"networkInterfaces": [ # An array of network access configurations for this interface.

1291

{ # A network interface resource attached to an instance.

1292

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

1293

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1294

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

1295

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

1296

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

1297

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1298

#

1299

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1300

#

1301

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

1302

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1303

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

1304

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1305

},

1306

],

1307

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1308

{ # An alias IP range attached to an instance's network interface.

1309

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

1310

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

1311

},

1312

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1313

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

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

[diff] [blame]

1314

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1315

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

1316

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

1317

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

1318

#

1319

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1320

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1321

# - projects/project/global/networks/network

1322

# - global/networks/default

1323

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

1324

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1325

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1326

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1327

# - regions/region/subnetworks/subnetwork

1328

},

1329

],

1330

"networkPerformanceConfig": {

1331

"totalEgressBandwidthTier": "A String",

1332

},

1333

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

1334

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1335

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

1336

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

1337

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

1338

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

1343

"A String",

1344

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1345

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Specifies the scheduling options for the instances that are created from these properties.

yoshi-code-bot

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

[diff] [blame]

1346

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

1347

#

1348

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

1349

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

1350

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

1351

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

yoshi-code-bot

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

[diff] [blame]

1352

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1353

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1354

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1355

"key": "A String", # Corresponds to the label key of Node resource.

1356

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1357

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

1363

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

1364

},

1365

"serviceAccounts": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.

1366

{ # A service account.

1367

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

1368

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1374

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1375

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1376

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1377

},

1378

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1379

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1380

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1381

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1382

},

1383

"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.

1384

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

1385

#

1386

# To see the latest fingerprint, make get() request to the instance.

1387

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1392

"locationPolicy": { # Configuration for location policy among multiple possible locations (e.g. preferences for zone selection among zones in a single region). # Policy for chosing target zone.

1393

"locations": { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

yoshi-code-bot

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

[diff] [blame]

1394

"a_key": {

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1395

"preference": "A String", # Preference for a given locaction: ALLOW or DENY.

yoshi-code-bot

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

[diff] [blame]

1396

},

1397

},

1398

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1399

"minCount": "A String", # The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.

1400

"namePattern": "A String", # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern should contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: name_pattern of inst-#### will generate instance names such as inst-0001, inst-0002, ... . If there already exist instance(s) whose names match the name pattern in the same project and zone, then the generated instance numbers will start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### will be inst-0051, inst-0052, etc. The name pattern placeholder #...# can contain up to 18 characters.

yoshi-code-bot

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

[diff] [blame]

1401

"perInstanceProperties": { # Per-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.

1402

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

1403

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

1404

},

1405

},

1406

"sourceInstanceTemplate": "A String", # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396.

1407

#

1408

# It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

1409

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

1410

# - projects/project/global/instanceTemplates/instanceTemplate

1411

# - global/instanceTemplates/instanceTemplate

1412

#

1413

# This field is optional.

1414

}

1415

1416

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.

1417

1418

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.

1419

1420

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

1421

1422

Returns:

1423

An object of the form:

1424

1425

{ # Represents an Operation resource.

1426

#

1427

# Google Compute Engine has three Operation resources:

1428

#

1429

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

1430

#

1431

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

1432

#

1433

# Operations can be global, regional or zonal.

1434

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

1435

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

1436

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

1437

#

1438

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

1439

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

1440

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

1441

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

1442

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

1443

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

1444

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

1445

{

1446

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

1447

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

1448

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

},

],

},

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

1453

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

1454

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

1455

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

1456

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

1457

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

1458

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

Yoshi Automation Bot

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

[diff] [blame]

1459

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

1460

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

1461

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

1462

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

1463

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

1464

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

1465

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

1466

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

1467

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

1468

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

1469

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

1470

{

1471

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

1472

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

1473

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

1474

{

1475

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

1476

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

1477

},

1478

],

1479

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

1480

},

1481

],

1482

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

1483

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

1487

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

1488

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1492

<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1493

<pre>Deletes the specified Instance resource. For more information, see Deleting an instance.

Sai Cheemalapati

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

[diff] [blame]

1494

1495

Args:

1496

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

1497

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

1498

instance: string, Name of the instance resource to delete. (required)

Bu Sun Kim

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

[diff] [blame]

1499

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.

1500

1501

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.

1502

1503

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]

1504

1505

Returns:

1506

An object of the form:

1507

Bu Sun Kim

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

[diff] [blame]

1508

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1509

#

1510

# Google Compute Engine has three Operation resources:

1511

#

1512

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

1513

#

1514

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

1515

#

1516

# Operations can be global, regional or zonal.

1517

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

1518

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

1519

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

1520

#

1521

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

1522

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

1523

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

1524

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

1525

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

1526

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

1527

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

Bu Sun Kim

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

[diff] [blame]

1528

{

Yoshi Automation Bot

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

[diff] [blame]

1529

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

1530

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

1531

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

Bu Sun Kim

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

[diff] [blame]

1532

},

1533

],

Yoshi Automation Bot

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

[diff] [blame]

1534

},

1535

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

1536

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

1537

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

1538

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

1539

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

1540

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

yoshi-code-bot

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

[diff] [blame]

1541

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

Yoshi Automation Bot

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

[diff] [blame]

1542

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

1543

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

1544

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

1545

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

1546

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

1547

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

1548

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

1549

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

1550

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

1551

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

1552

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

1553

{

1554

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

1555

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

1556

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

1557

{

1558

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

1559

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

1560

},

1561

],

1562

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

1563

},

1564

],

1565

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

1566

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

1570

<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

1571

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

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

[diff] [blame]

1572

1573

Args:

1574

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

1575

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

1576

instance: string, The instance name for this request. (required)

1577

accessConfig: string, The name of the access config to delete. (required)

1578

networkInterface: string, The name of the network interface. (required)

Bu Sun Kim

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

[diff] [blame]

1579

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.

1580

1581

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.

1582

1583

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]

1584

1585

Returns:

1586

An object of the form:

1587

Bu Sun Kim

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

[diff] [blame]

1588

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1589

#

1590

# Google Compute Engine has three Operation resources:

1591

#

1592

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

1593

#

1594

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

1595

#

1596

# Operations can be global, regional or zonal.

1597

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

1598

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

1599

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

1600

#

1601

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

1602

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

1603

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

1604

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

1605

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

1606

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

1607

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

Bu Sun Kim

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

[diff] [blame]

1608

{

Yoshi Automation Bot

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

[diff] [blame]

1609

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

1610

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

1611

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

Bu Sun Kim

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

[diff] [blame]

1612

},

1613

],

Yoshi Automation Bot

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

[diff] [blame]

1614

},

1615

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

1616

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

1617

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

1618

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

1619

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

1620

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

yoshi-code-bot

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

[diff] [blame]

1621

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

Yoshi Automation Bot

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

[diff] [blame]

1622

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

1623

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

1624

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

1625

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

1626

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

1627

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

1628

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

1629

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

1630

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

1631

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

1632

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

1633

{

1634

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

1635

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

1636

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

1637

{

1638

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

1639

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

1640

},

1641

],

1642

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

1643

},

1644

],

1645

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

1646

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

1650

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

Sai Cheemalapati

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

[diff] [blame]

1651

<pre>Detaches a disk from an instance.

1652

1653

Args:

1654

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

1655

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

Bu Sun Kim

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

[diff] [blame]

1656

instance: string, Instance name for this request. (required)

1657

deviceName: string, The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names. (required)

1658

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.

1659

1660

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.

1661

1662

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]

1663

1664

Returns:

1665

An object of the form:

1666

Bu Sun Kim

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

[diff] [blame]

1667

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1668

#

1669

# Google Compute Engine has three Operation resources:

1670

#

1671

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

1672

#

1673

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

1674

#

1675

# Operations can be global, regional or zonal.

1676

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

1677

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

1678

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

1679

#

1680

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

1681

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

1682

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

1683

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

1684

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

1685

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

1686

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

Bu Sun Kim

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

[diff] [blame]

1687

{

Yoshi Automation Bot

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

[diff] [blame]

1688

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

1689

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

1690

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

Bu Sun Kim

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

[diff] [blame]

1691

},

1692

],

Yoshi Automation Bot

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

[diff] [blame]

1693

},

1694

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

1695

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

1696

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

1697

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

1698

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

1699

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

yoshi-code-bot

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

[diff] [blame]

1700

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

Yoshi Automation Bot

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

[diff] [blame]

1701

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

1702

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

1703

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

1704

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

1705

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

1706

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

1707

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

1708

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

1709

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

1710

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

1711

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

1712

{

1713

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

1714

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

1715

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

1716

{

1717

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

1718

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

1719

},

1720

],

1721

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

1722

},

1723

],

1724

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

1725

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

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

Bu Sun Kim

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

[diff] [blame]

1730

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Sai Cheemalapati

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

[diff] [blame]

1731

1732

Args:

1733

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

1734

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

1735

instance: string, Name of the instance resource to return. (required)

1736

1737

Returns:

1738

An object of the form:

1739

Bu Sun Kim

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

[diff] [blame]

1740

{ # Represents an Instance resource.

Yoshi Automation Bot

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

[diff] [blame]

1741

#

1742

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

yoshi-code-bot

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

[diff] [blame]

1743

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

1744

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1745

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

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

[diff] [blame]

1746

},

Yoshi Automation Bot

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

[diff] [blame]

1747

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

1748

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1749

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1750

},

1751

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1752

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

1753

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1754

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1755

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

1756

{ # An instance-attached disk resource.

1757

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

1758

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

1759

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

1760

#

1761

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

1762

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

1763

#

1764

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

1765

#

1766

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

1767

#

1768

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

1769

#

1770

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

1771

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1772

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1773

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1774

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

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

[diff] [blame]

1775

#

Yoshi Automation Bot

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

[diff] [blame]

1776

# The key must meet the following requirements before you can provide it to Compute Engine:

1777

# - The key is wrapped using a RSA public key certificate provided by Google.

1778

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1779

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1780

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1781

},

1782

"diskSizeGb": "A String", # The size of the disk in GB.

1783

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

1784

{ # Guest OS features.

1785

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1786

},

1787

],

1788

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

1789

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

1790

#

1791

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1792

#

1793

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1794

"description": "A String", # An optional description. Provide this property when creating the disk.

1795

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

1796

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

1797

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

1798

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

Sai Cheemalapati

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

[diff] [blame]

1799

#

Sai Cheemalapati

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

[diff] [blame]

1800

#

Yoshi Automation Bot

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

[diff] [blame]

1801

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

1802

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

1803

# - projects/project/zones/zone/diskTypes/diskType

1804

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

1805

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Sai Cheemalapati

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

[diff] [blame]

1806

#

Yoshi Automation Bot

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

[diff] [blame]

1807

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1808

{ # Guest OS features.

1809

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1810

},

1811

],

1812

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

1813

"a_key": "A String",

1814

},

1815

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1816

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

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

[diff] [blame]

1817

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

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

[diff] [blame]

1818

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

1819

"A String",

1820

],

1821

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

1822

#

Yoshi Automation Bot

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

[diff] [blame]

1823

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

1824

# projects/debian-cloud/global/images/family/debian-9

1825

#

1826

#

1827

# Alternatively, use a specific version of a public operating system image:

1828

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1829

#

1830

#

1831

# To create a disk with a custom image that you created, specify the image name in the following format:

1832

# global/images/my-custom-image

1833

#

1834

#

1835

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

1836

# global/images/family/my-image-family

1837

#

1838

#

1839

# If the source image is deleted later, this field will not be set.

1840

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1841

#

1842

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

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

[diff] [blame]

1843

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1844

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1845

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1846

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

1847

#

1848

# The key must meet the following requirements before you can provide it to Compute Engine:

1849

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

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

[diff] [blame]

1850

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

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

[diff] [blame]

1851

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

1852

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

1853

},

Yoshi Automation Bot

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

[diff] [blame]

1854

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

Sai Cheemalapati

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

[diff] [blame]

1855

#

Yoshi Automation Bot

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

[diff] [blame]

1856

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1857

# global/snapshots/my-backup

Sai Cheemalapati

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

[diff] [blame]

1858

#

Yoshi Automation Bot

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

[diff] [blame]

1859

#

1860

# If the source snapshot is deleted later, this field will not be set.

1861

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1862

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1863

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

1864

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1865

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

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

[diff] [blame]

1866

#

Yoshi Automation Bot

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

[diff] [blame]

1867

# The key must meet the following requirements before you can provide it to Compute Engine:

1868

# - The key is wrapped using a RSA public key certificate provided by Google.

1869

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1870

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1871

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

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

[diff] [blame]

1872

},

Yoshi Automation Bot

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

[diff] [blame]

1873

},

1874

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

1875

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

1876

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1877

"A String",

1878

],

1879

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

1880

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

1881

"dbs": [ # The Key Database (db).

1882

{

Bu Sun Kim

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

[diff] [blame]

1883

"content": "A String", # The raw content in the secure keys file.

1884

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1885

},

Yoshi Automation Bot

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

[diff] [blame]

1886

],

1887

"dbxs": [ # The forbidden key database (dbx).

1888

{

1889

"content": "A String", # The raw content in the secure keys file.

1890

"fileType": "A String", # The file type of source file.

1891

},

1892

],

1893

"keks": [ # The Key Exchange Key (KEK).

1894

{

1895

"content": "A String", # The raw content in the secure keys file.

1896

"fileType": "A String", # The file type of source file.

1897

},

1898

],

1899

"pk": { # The Platform Key (PK).

1900

"content": "A String", # The raw content in the secure keys file.

1901

"fileType": "A String", # The file type of source file.

Dan O'Meara

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

[diff] [blame]

1902

},

Sai Cheemalapati

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

[diff] [blame]

1903

},

Yoshi Automation Bot

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

[diff] [blame]

1904

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Bu Sun Kim

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

[diff] [blame]

1905

#

Yoshi Automation Bot

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

[diff] [blame]

1906

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1907

#

1908

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1909

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

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

[diff] [blame]

1910

},

Yoshi Automation Bot

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

[diff] [blame]

1911

],

1912

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1913

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1914

},

1915

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

1916

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

1917

#

1918

# To see the latest fingerprint, make get() request to the instance.

1919

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1920

{ # A specification of the type and number of accelerator cards attached to the instance.

1921

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1922

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

1923

},

1924

],

1925

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

1926

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

1927

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

1928

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

1929

#

1930

# To see the latest fingerprint, make get() request to the instance.

1931

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1932

"a_key": "A String",

1933

},

1934

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1935

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1936

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

1937

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

1938

# zones/us-central1-f/machineTypes/n1-standard-1

1939

#

1940

#

1941

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

1942

# zones/zone/machineTypes/custom-CPUS-MEMORY

1943

#

1944

#

1945

# For example: zones/us-central1-f/machineTypes/custom-4-5120

1946

#

1947

# For a full list of restrictions, read the Specifications for custom machine types.

1948

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

1949

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

1950

#

1951

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

1952

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

1953

{

1954

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

1955

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

Bu Sun Kim

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

[diff] [blame]

1956

},

1957

],

Yoshi Automation Bot

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

[diff] [blame]

1958

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

1959

},

1960

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

1961

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1962

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

1963

{ # A network interface resource attached to an instance.

1964

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

1965

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1966

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

1967

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

1968

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

1969

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1970

#

1971

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1972

#

1973

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

1974

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1975

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

1976

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1977

},

Bu Sun Kim

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

[diff] [blame]

1978

],

Yoshi Automation Bot

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

[diff] [blame]

1979

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1980

{ # An alias IP range attached to an instance's network interface.

1981

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

1982

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

1983

},

1984

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1985

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

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

[diff] [blame]

1986

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1987

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

1988

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

1989

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

1990

#

1991

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1992

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1993

# - projects/project/global/networks/network

1994

# - global/networks/default

1995

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

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

[diff] [blame]

1996

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Yoshi Automation Bot

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

[diff] [blame]

1997

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1998

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1999

# - regions/region/subnetworks/subnetwork

Bu Sun Kim

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

[diff] [blame]

2000

},

Yoshi Automation Bot

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

[diff] [blame]

2001

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2002

"networkPerformanceConfig": {

2003

"totalEgressBandwidthTier": "A String",

2004

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2005

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2006

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2007

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2008

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

2009

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

2010

"values": [ # Corresponds to the label values of a reservation resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2011

"A String",

2012

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2013

},

2014

"resourcePolicies": [ # Resource policies applied to this instance.

2015

"A String",

2016

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2017

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2018

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2019

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2020

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2021

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2022

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

2023

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2024

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2025

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2026

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2027

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2028

"key": "A String", # Corresponds to the label key of Node resource.

2029

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2030

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2035

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

2036

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

2037

},

2038

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2039

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2040

#

2041

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

2042

{ # A service account.

2043

"email": "A String", # Email address of the service account.

2044

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2045

"A String",

2046

],

2047

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2048

],

2049

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2050

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2051

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2052

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2053

},

2054

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2055

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2056

},

2057

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

2058

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2059

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2060

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2061

},

2062

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

2063

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2064

},

2065

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2066

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2067

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2068

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2069

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2070

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2071

#

2072

# The key must meet the following requirements before you can provide it to Compute Engine:

2073

# - The key is wrapped using a RSA public key certificate provided by Google.

2074

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2075

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2076

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2077

},

2078

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

2079

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

2080

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2081

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

2082

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

2083

#

2084

# To see the latest fingerprint, make get() request to the instance.

2085

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2090

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2094

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

2095

<pre>Returns effective firewalls applied to an interface of the instance.

2096

2097

Args:

2098

project: string, Project ID for this request. (required)

2099

zone: string, The name of the zone for this request. (required)

2100

instance: string, Name of the instance scoping this request. (required)

2101

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

2102

2103

Returns:

2104

An object of the form:

2105

2106

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2107

"firewallPolicys": [ # Effective firewalls from firewall policies.

2108

{

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2109

"displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2110

"name": "A String", # [Output Only] The name of the firewall policy.

2111

"rules": [ # The rules that apply to the network.

2112

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

2113

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2114

"description": "A String", # An optional description for this resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2115

"direction": "A String", # The direction in which this rule applies.

2116

"disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.

2117

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

2118

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2119

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2120

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

2121

"A String",

2122

],

2123

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2124

{

2125

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

2126

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

2127

#

2128

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

2134

"A String",

2135

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2136

},

2137

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.

2138

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2139

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2140

"A String",

2141

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2142

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

"A String",

],

},

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2147

"shortName": "A String", # [Output Only] The short name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2148

"type": "A String", # [Output Only] The type of the firewall policy.

2149

},

2150

],

2151

"firewalls": [ # Effective firewalls on the instance.

2152

{ # Represents a Firewall Rule resource.

2153

#

2154

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

2155

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2156

{

2157

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

2158

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

2159

#

2160

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2166

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2167

{

2168

"IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.

2169

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

2170

#

2171

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

2177

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

2178

"A String",

2179

],

2180

"direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.

2181

"disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.

2182

"enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported t Cloud Logging.

2183

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2184

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

2185

"logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Cloud Logging.

2186

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2187

"metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs.

2188

},

2189

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

2190

"network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:

2191

# global/networks/default

2192

# If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2193

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

2194

# - projects/myproject/global/networks/my-network

2195

# - global/networks/default

2196

"priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.

2197

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2198

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

2199

"A String",

2200

],

2201

"sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.

2202

"A String",

2203

],

2204

"sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.

2205

"A String",

2206

],

2207

"targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.

2208

"A String",

2209

],

2210

"targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.

"A String",

],

},

],

"organizationFirewalls": [ # Effective firewalls from organization policies.

2216

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

2217

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2218

"rules": [ # The rules that apply to the network.

2219

{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2220

"action": "A String", # The Action to perform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2221

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2222

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

2223

"enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.

2224

#

2225

# This field may only be specified when the versioned_expr is set to FIREWALL.

2226

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2227

"match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.

2228

"config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.

2229

"destIpRanges": [ # CIDR IP address range.

2230

#

2231

# This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2232

"A String",

2233

],

2234

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2235

#

2236

# This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2237

{

2238

"ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.

2239

"ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.

2240

#

2241

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2242

#

2243

# This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2248

"srcIpRanges": [ # CIDR IP address range. Maximum number of src_ip_ranges allowed is 10.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2249

"A String",

2250

],

2251

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2252

"expr": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2253

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2254

# Example (Comparison):

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2255

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2256

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2257

#

2258

# Example (Equality):

2259

#

2260

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

2265

#

2266

# Example (Data Manipulation):

2267

#

2268

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2269

#

2270

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

2271

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2272

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2273

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2274

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

2275

},

2276

"versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2277

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2278

"preview": True or False, # If set to true, the specified action is not enforced.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2279

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2280

"ruleNumber": "A String", # Identifier for the rule. This is only unique within the given security policy. This can only be set during rule creation, if rule number is not specified it will be generated by the server.

2281

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

2282

"targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.

2283

#

2284

# This field may only be specified when versioned_expr is set to FIREWALL.

2285

"A String",

2286

],

2287

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

2288

"A String",

2289

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2290

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

],

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2298

<code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2299

<pre>Returns the specified guest attributes entry.

2300

2301

Args:

2302

project: string, Project ID for this request. (required)

2303

zone: string, The name of the zone for this request. (required)

2304

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2305

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2306

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2307

2308

Returns:

2309

An object of the form:

2310

2311

{ # A guest attributes entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2312

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

2313

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

2314

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

2315

"items": [

2316

{ # A guest attributes namespace/key/value entry.

2317

"key": "A String", # Key for the guest attribute entry.

2318

"namespace": "A String", # Namespace for the guest attribute entry.

2319

"value": "A String", # Value for the guest attribute entry.

},

],

},

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2324

"variableKey": "A String", # The key to search for.

2325

"variableValue": "A String", # [Output Only] The value found for the requested key.

2326

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2330

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2331

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

2332

2333

Args:

2334

project: string, Project ID for this request. (required)

2335

zone: string, The name of the zone for this request. (required)

2336

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2337

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2338

2339

Returns:

2340

An object of the form:

2341

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2342

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

2347

#

2348

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

2357

#

2358

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

2359

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

2360

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

2361

#

2362

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

2363

#

2364

# Example Policy with multiple AuditConfigs:

2365

#

2366

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

2367

#

2368

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

2369

"auditLogConfigs": [ # The configuration for logging of each type of permission.

2370

{ # Provides the configuration for logging a type of permissions. Example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2371

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2372

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2373

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2374

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

2375

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

2376

"A String",

2377

],

2378

"ignoreChildExemptions": True or False,

2379

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2380

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

2386

},

2387

],

2388

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

2389

{ # Associates `members` with a `role`.

2390

"bindingId": "A String",

2391

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

2392

#

2393

# If the condition evaluates to `true`, then this binding applies to the current request.

2394

#

2395

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

2396

#

2397

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2398

#

2399

# Example (Comparison):

2400

#

2401

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

2402

#

2403

# Example (Equality):

2404

#

2405

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

2410

#

2411

# Example (Data Manipulation):

2412

#

2413

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

2414

#

2415

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

2416

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2417

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2418

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2419

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2420

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2421

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

2422

#

2423

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

2424

#

2425

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2426

#

2427

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

2432

#

2433

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

2434

#

2435

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

2436

#

2437

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

2438

#

2439

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

2444

"A String",

2445

],

2446

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2447

},

2448

],

2449

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

2450

#

2451

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2452

"iamOwned": True or False,

2453

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

2454

{ # A rule to be applied in a Policy.

2455

"action": "A String", # Required

2456

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

2457

{ # A condition to be met.

2458

"iam": "A String", # Trusted attributes supplied by the IAM system.

2459

"op": "A String", # An operator to apply the subject with.

2460

"svc": "A String", # Trusted attributes discharged by the service.

2461

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

2462

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

2468

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

2469

"A String",

2470

],

2471

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

2472

{ # Specifies what kind of log the caller must write

2473

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

2474

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

2475

"permissionType": "A String", # The type of the permission that was checked.

2476

},

2477

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2478

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2479

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

2480

#

2481

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

2482

#

2483

# Field names correspond to IAM request parameters and field values are their respective values.

2484

#

2485

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

2486

#

2487

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

2488

"customFields": [ # Custom fields.

2489

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

2490

"name": "A String", # Name is the field name.

2491

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2492

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2493

],

2494

"field": "A String", # The field value to attribute.

2495

"metric": "A String", # The metric to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2496

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2497

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

2498

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

2503

"A String",

2504

],

2505

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

2511

#

2512

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

2513

#

2514

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

2515

#

2516

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

2517

#

2518

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

2519

#

2520

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

2521

#

2522

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

2523

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2527

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

2528

<pre>Returns the screenshot from the specified instance.

2529

2530

Args:

2531

project: string, Project ID for this request. (required)

2532

zone: string, The name of the zone for this request. (required)

2533

instance: string, Name of the instance scoping this request. (required)

2534

2535

Returns:

2536

An object of the form:

2537

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2538

{ # An instance's screenshot.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2539

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

2540

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

2541

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2545

<code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2546

<pre>Returns the last 1 MB of serial port output from the specified instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2547

2548

Args:

2549

project: string, Project ID for this request. (required)

2550

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2551

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2552

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2553

start: string, Specifies the starting byte position of the output to return. To start with the first byte of output to the specified port, omit this field or set it to `0`.

2554

2555

If the output for that byte position is available, this field matches the `start` parameter sent with the request. If the amount of serial console output exceeds the size of the buffer (1 MB), the oldest output is discarded and is no longer available. If the requested start position refers to discarded output, the start position is adjusted to the oldest output still available, and the adjusted start position is returned as the `start` property value.

2556

2557

You can also provide a negative start position, which translates to the most recent number of bytes written to the serial port. For example, -3 is interpreted as the most recent 3 bytes written to the serial console.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2558

2559

Returns:

2560

An object of the form:

2561

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2562

{ # An instance's serial console output.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2563

"contents": "A String", # [Output Only] The contents of the console output.

2564

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

2565

"next": "A String", # [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter.

2566

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2567

"start": "A String", # The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request.

2568

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2572

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

2573

<pre>Returns the Shielded Instance Identity of an instance

2574

2575

Args:

2576

project: string, Project ID for this request. (required)

2577

zone: string, The name of the zone for this request. (required)

2578

instance: string, Name or id of the instance scoping this request. (required)

2579

2580

Returns:

2581

An object of the form:

2582

2583

{ # A shielded Instance identity entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2584

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2585

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2586

"ekPub": "A String", # A PEM-encoded public key.

2587

},

2588

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

2589

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2590

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2591

"ekPub": "A String", # A PEM-encoded public key.

2592

},

2593

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</code>

2598

<pre>Returns the Shielded VM Identity of an instance

2599

2600

Args:

2601

project: string, Project ID for this request. (required)

2602

zone: string, The name of the zone for this request. (required)

2603

instance: string, Name of the instance scoping this request. (required)

2604

2605

Returns:

2606

An object of the form:

2607

2608

{ # A shielded VM identity entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2609

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

2610

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2611

"ekPub": "A String", # A PEM-encoded public key.

2612

},

2613

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

2614

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

2615

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2616

"ekPub": "A String", # A PEM-encoded public key.

2617

},

2618

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2622

<code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2623

<pre>Creates an instance resource in the specified project using the data included in the request.

2624

2625

Args:

2626

project: string, Project ID for this request. (required)

2627

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2628

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2629

The object takes the form of:

2630

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2631

{ # Represents an Instance resource.

2632

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2633

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2634

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

2635

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2636

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2637

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2638

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2639

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2640

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2641

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2642

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2643

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2644

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2645

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2646

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2647

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2648

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

2649

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

2650

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

2651

#

2652

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2653

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2654

#

2655

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

2656

#

2657

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

2658

#

2659

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

2660

#

2661

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2662

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2663

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2664

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2665

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2666

#

2667

# The key must meet the following requirements before you can provide it to Compute Engine:

2668

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2669

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2670

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2671

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2672

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2673

"diskSizeGb": "A String", # The size of the disk in GB.

2674

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

2675

{ # Guest OS features.

2676

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2677

},

2678

],

2679

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

2680

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2681

#

2682

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2683

#

2684

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2685

"description": "A String", # An optional description. Provide this property when creating the disk.

2686

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

2687

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

2688

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2689

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2690

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2691

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2692

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

2693

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2694

# - projects/project/zones/zone/diskTypes/diskType

2695

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2696

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2697

#

2698

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2699

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2700

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2701

},

2702

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2703

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

2704

"a_key": "A String",

2705

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2706

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2707

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2708

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2709

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

2710

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2711

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2712

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2713

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2714

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

2715

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2716

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2717

#

2718

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2719

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2720

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2721

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2722

# To create a disk with a custom image that you created, specify the image name in the following format:

2723

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2724

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2725

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2726

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

2727

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2728

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2729

#

2730

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2731

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2732

#

2733

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

2734

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2735

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2736

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2737

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2738

#

2739

# The key must meet the following requirements before you can provide it to Compute Engine:

2740

# - The key is wrapped using a RSA public key certificate provided by Google.

2741

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2742

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2743

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2744

},

2745

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

2746

#

2747

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2748

# global/snapshots/my-backup

2749

#

2750

#

2751

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2752

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2753

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2754

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2755

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2756

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2757

#

2758

# The key must meet the following requirements before you can provide it to Compute Engine:

2759

# - The key is wrapped using a RSA public key certificate provided by Google.

2760

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2761

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2762

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2763

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2764

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2765

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

2766

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2767

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2768

"A String",

2769

],

2770

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

2771

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

2772

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2773

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2774

"content": "A String", # The raw content in the secure keys file.

2775

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2776

},

2777

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2778

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2779

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2780

"content": "A String", # The raw content in the secure keys file.

2781

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2782

},

2783

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2784

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2785

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2786

"content": "A String", # The raw content in the secure keys file.

2787

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2788

},

2789

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2790

"pk": { # The Platform Key (PK).

2791

"content": "A String", # The raw content in the secure keys file.

2792

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2793

},

2794

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2795

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2796

#

2797

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2798

#

2799

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2800

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2801

},

2802

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2803

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2804

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2805

},

2806

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2807

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

2808

#

2809

# To see the latest fingerprint, make get() request to the instance.

2810

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2811

{ # A specification of the type and number of accelerator cards attached to the instance.

2812

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2813

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

2814

},

2815

],

2816

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

2817

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2818

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2819

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

2820

#

2821

# To see the latest fingerprint, make get() request to the instance.

2822

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2823

"a_key": "A String",

2824

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2825

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2826

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2827

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2828

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

2829

# zones/us-central1-f/machineTypes/n1-standard-1

2830

#

2831

#

2832

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

2833

# zones/zone/machineTypes/custom-CPUS-MEMORY

2834

#

2835

#

2836

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2837

#

2838

# For a full list of restrictions, read the Specifications for custom machine types.

2839

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2840

"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.

2841

#

2842

# To see the latest fingerprint, make a get() request to retrieve the resource.

2843

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2844

{

2845

"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.

2846

"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).

2847

},

2848

],

2849

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2850

},

2851

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

2852

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2853

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

2854

{ # A network interface resource attached to an instance.

2855

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

2856

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2857

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2858

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

2859

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

2860

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2861

#

2862

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2863

#

2864

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

2865

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2866

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

2867

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2868

},

2869

],

2870

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2871

{ # An alias IP range attached to an instance's network interface.

2872

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

2873

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

2874

},

2875

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2876

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2877

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2878

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2879

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

2880

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

2881

#

2882

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2883

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2884

# - projects/project/global/networks/network

2885

# - global/networks/default

2886

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2887

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2888

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

2889

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2890

# - regions/region/subnetworks/subnetwork

2891

},

2892

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2893

"networkPerformanceConfig": {

2894

"totalEgressBandwidthTier": "A String",

2895

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2896

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2897

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2898

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2899

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

2900

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

2901

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2906

"A String",

2907

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2908

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2909

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2910

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

2911

#

2912

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2913

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

2914

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2915

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2916

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2917

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2918

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2919

"key": "A String", # Corresponds to the label key of Node resource.

2920

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2921

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2927

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2928

},

2929

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2930

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2931

#

2932

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

2933

{ # A service account.

2934

"email": "A String", # Email address of the service account.

2935

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2941

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2942

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2943

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2944

},

2945

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2946

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2947

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2948

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2949

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2950

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2951

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2952

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2953

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2954

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2955

},

2956

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2957

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2958

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2959

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

2960

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2961

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2962

#

2963

# The key must meet the following requirements before you can provide it to Compute Engine:

2964

# - The key is wrapped using a RSA public key certificate provided by Google.

2965

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2966

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2967

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2968

},

2969

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2970

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2971

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2972

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

2973

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

2974

#

2975

# To see the latest fingerprint, make get() request to the instance.

2976

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2981

}

2982

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2983

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.

2984

2985

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.

2986

2987

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2988

sourceInstanceTemplate: string, Specifies instance template to create the instance.

2989

2990

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

2991

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

2992

- projects/project/global/instanceTemplates/instanceTemplate

2993

- global/instanceTemplates/instanceTemplate

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2994

sourceMachineImage: string, Specifies the machine image to use to create the instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2995

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2996

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2997

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

2998

- projects/project/global/global/machineImages/machineImage

2999

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3000

3001

Returns:

3002

An object of the form:

3003

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3004

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3005

#

3006

# Google Compute Engine has three Operation resources:

3007

#

3008

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3009

#

3010

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3011

#

3012

# Operations can be global, regional or zonal.

3013

# - For global operations, use the `globalOperations` resource.

3014

# - For regional operations, use the `regionOperations` resource.

3015

# - For zonal operations, use the `zonalOperations` resource.

3016

#

3017

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3018

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3019

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3020

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3021

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3022

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3023

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3024

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3025

"code": "A String", # [Output Only] The error type identifier for this error.

3026

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3027

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3028

},

3029

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3030

},

3031

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3032

"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.

3033

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3034

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3035

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3036

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3037

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3038

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3039

"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.

3040

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3041

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3042

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3043

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3044

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3045

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3046

"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.

3047

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3048

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3049

{

3050

"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.

3051

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3052

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3053

{

3054

"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).

3055

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3056

},

3057

],

3058

"message": "A String", # [Output Only] A human-readable description of the warning code.

3059

},

3060

],

3061

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3062

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3066

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3067

<pre>Retrieves the list of instances contained within the specified zone.

3068

3069

Args:

3070

project: string, Project ID for this request. (required)

3071

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3072

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3073

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3074

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3075

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3076

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3077

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3078

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) ```

3079

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`)

3080

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3081

3082

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.

3083

3084

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3085

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3086

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3087

3088

Returns:

3089

An object of the form:

3090

3091

{ # Contains a list of instances.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3092

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3093

"items": [ # A list of Instance resources.

3094

{ # Represents an Instance resource.

3095

#

3096

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3097

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

3098

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

3099

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3100

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3101

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

3102

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3103

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

3104

},

3105

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3106

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3107

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3108

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3109

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

3110

{ # An instance-attached disk resource.

3111

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

3112

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

3113

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

3114

#

3115

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

3116

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

3117

#

3118

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

3119

#

3120

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

3121

#

3122

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

3123

#

3124

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

3125

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3126

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3127

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3128

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3129

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3130

# The key must meet the following requirements before you can provide it to Compute Engine:

3131

# - The key is wrapped using a RSA public key certificate provided by Google.

3132

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3133

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3134

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3135

},

3136

"diskSizeGb": "A String", # The size of the disk in GB.

3137

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

3138

{ # Guest OS features.

3139

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3140

},

3141

],

3142

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

3143

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

3144

#

3145

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3146

#

3147

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3148

"description": "A String", # An optional description. Provide this property when creating the disk.

3149

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

3150

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

3151

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

3152

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3153

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3154

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3155

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

3156

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3157

# - projects/project/zones/zone/diskTypes/diskType

3158

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

3159

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3160

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3161

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3162

{ # Guest OS features.

3163

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3164

},

3165

],

3166

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

3167

"a_key": "A String",

3168

},

3169

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

3170

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3171

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3172

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

3173

"A String",

3174

],

3175

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3176

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3177

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

3178

# projects/debian-cloud/global/images/family/debian-9

3179

#

3180

#

3181

# Alternatively, use a specific version of a public operating system image:

3182

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

3183

#

3184

#

3185

# To create a disk with a custom image that you created, specify the image name in the following format:

3186

# global/images/my-custom-image

3187

#

3188

#

3189

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

3190

# global/images/family/my-image-family

3191

#

3192

#

3193

# If the source image is deleted later, this field will not be set.

3194

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

3195

#

3196

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3197

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3198

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3199

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3200

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3201

#

3202

# The key must meet the following requirements before you can provide it to Compute Engine:

3203

# - The key is wrapped using a RSA public key certificate provided by Google.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3204

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3205

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3206

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3207

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3208

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3209

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3210

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3211

# global/snapshots/my-backup

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3212

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3213

#

3214

# If the source snapshot is deleted later, this field will not be set.

3215

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

3216

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3217

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3218

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3219

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3220

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3221

# The key must meet the following requirements before you can provide it to Compute Engine:

3222

# - The key is wrapped using a RSA public key certificate provided by Google.

3223

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3224

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3225

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3226

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3227

},

3228

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

3229

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3230

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3231

"A String",

3232

],

3233

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

3234

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

3235

"dbs": [ # The Key Database (db).

3236

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3237

"content": "A String", # The raw content in the secure keys file.

3238

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3239

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3240

],

3241

"dbxs": [ # The forbidden key database (dbx).

3242

{

3243

"content": "A String", # The raw content in the secure keys file.

3244

"fileType": "A String", # The file type of source file.

3245

},

3246

],

3247

"keks": [ # The Key Exchange Key (KEK).

3248

{

3249

"content": "A String", # The raw content in the secure keys file.

3250

"fileType": "A String", # The file type of source file.

3251

},

3252

],

3253

"pk": { # The Platform Key (PK).

3254

"content": "A String", # The raw content in the secure keys file.

3255

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3256

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3257

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3258

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3259

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3260

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3261

#

3262

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

3263

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3264

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3265

],

3266

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3267

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

3268

},

3269

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3270

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

3271

#

3272

# To see the latest fingerprint, make get() request to the instance.

3273

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3274

{ # A specification of the type and number of accelerator cards attached to the instance.

3275

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3276

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

3277

},

3278

],

3279

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

3280

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3281

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3282

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

3283

#

3284

# To see the latest fingerprint, make get() request to the instance.

3285

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3286

"a_key": "A String",

3287

},

3288

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3289

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3290

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

3291

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

3292

# zones/us-central1-f/machineTypes/n1-standard-1

3293

#

3294

#

3295

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

3296

# zones/zone/machineTypes/custom-CPUS-MEMORY

3297

#

3298

#

3299

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3300

#

3301

# For a full list of restrictions, read the Specifications for custom machine types.

3302

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3303

"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.

3304

#

3305

# To see the latest fingerprint, make a get() request to retrieve the resource.

3306

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3307

{

3308

"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.

3309

"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).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3310

},

3311

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3312

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3313

},

3314

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

3315

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

3316

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

3317

{ # A network interface resource attached to an instance.

3318

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

3319

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3320

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3321

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

3322

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

3323

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3324

#

3325

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3326

#

3327

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

3328

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3329

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

3330

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3331

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3332

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3333

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3334

{ # An alias IP range attached to an instance's network interface.

3335

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

3336

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

3337

},

3338

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3339

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3340

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3341

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3342

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

3343

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

3344

#

3345

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

3346

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

3347

# - projects/project/global/networks/network

3348

# - global/networks/default

3349

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3350

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3351

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

3352

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3353

# - regions/region/subnetworks/subnetwork

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3354

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3355

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3356

"networkPerformanceConfig": {

3357

"totalEgressBandwidthTier": "A String",

3358

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3359

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3360

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

3361

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

3362

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

3363

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

3364

"values": [ # Corresponds to the label values of a reservation resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3365

"A String",

3366

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3367

},

3368

"resourcePolicies": [ # Resource policies applied to this instance.

3369

"A String",

3370

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3371

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3372

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3373

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3374

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3375

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3376

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

3377

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

3378

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3379

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3380

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3381

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3382

"key": "A String", # Corresponds to the label key of Node resource.

3383

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3384

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3389

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

3390

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

3391

},

3392

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3393

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3394

#

3395

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

3396

{ # A service account.

3397

"email": "A String", # Email address of the service account.

3398

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3399

"A String",

3400

],

3401

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3402

],

3403

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3404

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3405

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3406

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3407

},

3408

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3409

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3410

},

3411

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

3412

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3413

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3414

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3415

},

3416

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

3417

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3418

},

3419

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3420

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3421

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3422

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3423

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3424

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3425

#

3426

# The key must meet the following requirements before you can provide it to Compute Engine:

3427

# - The key is wrapped using a RSA public key certificate provided by Google.

3428

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3429

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3430

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3431

},

3432

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

3433

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

3434

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3435

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

3436

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

3437

#

3438

# To see the latest fingerprint, make get() request to the instance.

3439

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

3444

},

3445

],

3446

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

3447

"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.

3448

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3449

"warning": { # [Output Only] Informational warning message.

3450

"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.

3451

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3452

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3453

{

3454

"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).

3455

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3456

},

3457

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3458

"message": "A String", # [Output Only] A human-readable description of the warning code.

3459

},

3460

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3464

<code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3465

<pre>Retrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged instance group, the referrers list includes the instance group. For more information, read Viewing referrers to VM instances.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3466

3467

Args:

3468

project: string, Project ID for this request. (required)

3469

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3470

instance: string, Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3471

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3472

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3473

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3474

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3475

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3476

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3477

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) ```

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3478

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3479

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3480

3481

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.

3482

3483

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3484

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3485

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3486

3487

Returns:

3488

An object of the form:

3489

3490

{ # Contains a list of instance referrers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3491

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3492

"items": [ # A list of Reference resources.

3493

{ # Represents a reference to a resource.

3494

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

3495

"referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include:

3496

# - MEMBER_OF

3497

"referrer": "A String", # URL of the resource which refers to the target.

3498

"target": "A String", # URL of the resource to which this reference points.

3499

},

3500

],

3501

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

3502

"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.

3503

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3504

"warning": { # [Output Only] Informational warning message.

3505

"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.

3506

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3507

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3508

{

3509

"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).

3510

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3511

},

3512

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3513

"message": "A String", # [Output Only] A human-readable description of the warning code.

3514

},

3515

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

<code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code>

3520

<pre>Retrieves the next page of results.

3521

3522

Args:

3523

previous_request: The request for the previous page. (required)

3524

previous_response: The response from the request for the previous page. (required)

3525

3526

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3527

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3528

page. Returns None if there are no more items in the collection.

</pre>

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3533

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3534

<pre>Retrieves the next page of results.

3535

3536

Args:

3537

previous_request: The request for the previous page. (required)

3538

previous_response: The response from the request for the previous page. (required)

3539

3540

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3541

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3542

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]

3547

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</code>

3548

<pre>Removes resource policies from an instance.

3549

3550

Args:

3551

project: string, Project ID for this request. (required)

3552

zone: string, The name of the zone for this request. (required)

3553

instance: string, The instance name for this request. (required)

3554

body: object, The request body.

3555

The object takes the form of:

3556

3557

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3558

"resourcePolicies": [ # Resource policies to be removed from this instance.

3559

"A String",

3560

],

3561

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3562

3563

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.

3564

3565

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.

3566

3567

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3568

3569

Returns:

3570

An object of the form:

3571

3572

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3573

#

3574

# Google Compute Engine has three Operation resources:

3575

#

3576

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3577

#

3578

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3579

#

3580

# Operations can be global, regional or zonal.

3581

# - For global operations, use the `globalOperations` resource.

3582

# - For regional operations, use the `regionOperations` resource.

3583

# - For zonal operations, use the `zonalOperations` resource.

3584

#

3585

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3586

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3587

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3588

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3589

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3590

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3591

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3592

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3593

"code": "A String", # [Output Only] The error type identifier for this error.

3594

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3595

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3596

},

3597

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3598

},

3599

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3600

"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.

3601

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3602

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3603

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3604

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3605

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3606

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3607

"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.

3608

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3609

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3610

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3611

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3612

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3613

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3614

"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.

3615

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3616

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3617

{

3618

"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.

3619

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3620

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3621

{

3622

"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).

3623

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3624

},

3625

],

3626

"message": "A String", # [Output Only] A human-readable description of the warning code.

3627

},

3628

],

3629

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3630

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3634

<code class="details" id="reset">reset(project, zone, instance, requestId=None)</code>

3635

<pre>Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3636

3637

Args:

3638

project: string, Project ID for this request. (required)

3639

zone: string, The name of the zone for this request. (required)

3640

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3641

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.

3642

3643

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.

3644

3645

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]

3646

3647

Returns:

3648

An object of the form:

3649

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3650

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3651

#

3652

# Google Compute Engine has three Operation resources:

3653

#

3654

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3655

#

3656

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3657

#

3658

# Operations can be global, regional or zonal.

3659

# - For global operations, use the `globalOperations` resource.

3660

# - For regional operations, use the `regionOperations` resource.

3661

# - For zonal operations, use the `zonalOperations` resource.

3662

#

3663

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3664

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3665

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3666

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3667

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3668

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3669

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3670

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3671

"code": "A String", # [Output Only] The error type identifier for this error.

3672

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3673

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3674

},

3675

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3676

},

3677

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3678

"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.

3679

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3680

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3681

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3682

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3683

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3684

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3685

"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.

3686

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3687

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3688

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3689

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3690

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3691

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3692

"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.

3693

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3694

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3695

{

3696

"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.

3697

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3698

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3699

{

3700

"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).

3701

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3702

},

3703

],

3704

"message": "A String", # [Output Only] A human-readable description of the warning code.

3705

},

3706

],

3707

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3708

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3712

<code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3713

<pre>Resumes an instance that was suspended using the instances().suspend method.

3714

3715

Args:

3716

project: string, Project ID for this request. (required)

3717

zone: string, The name of the zone for this request. (required)

3718

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3719

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3720

The object takes the form of:

3721

3722

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3723

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

3724

#

3725

# In order to resume the instance, the disk url and its corresponding key must be provided.

3726

#

3727

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

3728

{

3729

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

3730

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3731

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3732

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3733

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3734

#

3735

# The key must meet the following requirements before you can provide it to Compute Engine:

3736

# - The key is wrapped using a RSA public key certificate provided by Google.

3737

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3738

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3739

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3740

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3741

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3742

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3743

],

3744

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

3745

#

3746

# If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance resume will not succeed.

3747

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3748

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

3749

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3750

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3751

#

3752

# The key must meet the following requirements before you can provide it to Compute Engine:

3753

# - The key is wrapped using a RSA public key certificate provided by Google.

3754

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3755

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3756

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3757

},

3758

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3759

3760

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.

3761

3762

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.

3763

3764

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3765

3766

Returns:

3767

An object of the form:

3768

3769

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3770

#

3771

# Google Compute Engine has three Operation resources:

3772

#

3773

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3774

#

3775

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3776

#

3777

# Operations can be global, regional or zonal.

3778

# - For global operations, use the `globalOperations` resource.

3779

# - For regional operations, use the `regionOperations` resource.

3780

# - For zonal operations, use the `zonalOperations` resource.

3781

#

3782

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3783

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3784

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3785

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3786

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3787

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3788

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3789

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3790

"code": "A String", # [Output Only] The error type identifier for this error.

3791

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3792

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3793

},

3794

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3795

},

3796

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3797

"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.

3798

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3799

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3800

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3801

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3802

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3803

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3804

"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.

3805

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3806

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3807

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3808

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3809

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3810

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3811

"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.

3812

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3813

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3814

{

3815

"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.

3816

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3817

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3818

{

3819

"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).

3820

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3821

},

3822

],

3823

"message": "A String", # [Output Only] A human-readable description of the warning code.

3824

},

3825

],

3826

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3827

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</code>

3832

<pre>Sets deletion protection on the instance.

3833

3834

Args:

3835

project: string, Project ID for this request. (required)

3836

zone: string, The name of the zone for this request. (required)

3837

resource: string, Name or id of the resource for this request. (required)

3838

deletionProtection: boolean, Whether the resource should be protected against deletion.

3839

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.

3840

3841

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.

3842

3843

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

3844

3845

Returns:

3846

An object of the form:

3847

3848

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3849

#

3850

# Google Compute Engine has three Operation resources:

3851

#

3852

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3853

#

3854

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3855

#

3856

# Operations can be global, regional or zonal.

3857

# - For global operations, use the `globalOperations` resource.

3858

# - For regional operations, use the `regionOperations` resource.

3859

# - For zonal operations, use the `zonalOperations` resource.

3860

#

3861

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3862

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3863

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3864

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3865

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3866

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3867

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3868

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3869

"code": "A String", # [Output Only] The error type identifier for this error.

3870

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3871

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3872

},

3873

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3874

},

3875

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3876

"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.

3877

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3878

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3879

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3880

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3881

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3882

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3883

"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.

3884

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3885

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3886

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3887

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3888

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3889

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3890

"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.

3891

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3892

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3893

{

3894

"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.

3895

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3896

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3897

{

3898

"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).

3899

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3900

},

3901

],

3902

"message": "A String", # [Output Only] A human-readable description of the warning code.

3903

},

3904

],

3905

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3906

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3911

<pre>Sets the auto-delete flag for a disk attached to an instance.

3912

3913

Args:

3914

project: string, Project ID for this request. (required)

3915

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3916

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3917

autoDelete: boolean, Whether to auto-delete the disk when the instance is deleted. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3918

deviceName: string, The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names. (required)

3919

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.

3920

3921

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.

3922

3923

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]

3924

3925

Returns:

3926

An object of the form:

3927

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3928

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3929

#

3930

# Google Compute Engine has three Operation resources:

3931

#

3932

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3933

#

3934

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3935

#

3936

# Operations can be global, regional or zonal.

3937

# - For global operations, use the `globalOperations` resource.

3938

# - For regional operations, use the `regionOperations` resource.

3939

# - For zonal operations, use the `zonalOperations` resource.

3940

#

3941

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3942

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3943

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3944

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3945

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3946

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3947

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3948

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3949

"code": "A String", # [Output Only] The error type identifier for this error.

3950

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3951

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3952

},

3953

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3954

},

3955

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3956

"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.

3957

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3958

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3959

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3960

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3961

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3962

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3963

"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.

3964

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3965

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3966

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3967

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3968

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3969

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3970

"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.

3971

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3972

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3973

{

3974

"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.

3975

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3976

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3977

{

3978

"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).

3979

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3980

},

3981

],

3982

"message": "A String", # [Output Only] A human-readable description of the warning code.

3983

},

3984

],

3985

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3986

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3990

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3991

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

3992

3993

Args:

3994

project: string, Project ID for this request. (required)

3995

zone: string, The name of the zone for this request. (required)

3996

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3997

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3998

The object takes the form of:

3999

4000

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4001

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

4002

{ # Associates `members` with a `role`.

4003

"bindingId": "A String",

4004

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4005

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4006

# If the condition evaluates to `true`, then this binding applies to the current request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4007

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4008

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4009

#

4010

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4011

#

4012

# Example (Comparison):

4013

#

4014

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4015

#

4016

# Example (Equality):

4017

#

4018

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

4023

#

4024

# Example (Data Manipulation):

4025

#

4026

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4027

#

4028

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

4029

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

4030

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4031

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

4032

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

4033

},

4034

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

4035

#

4036

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4037

#

4038

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4039

#

4040

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

4045

#

4046

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4047

#

4048

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

4049

#

4050

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

4051

#

4052

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

4057

"A String",

4058

],

4059

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4060

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4061

],

4062

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

4063

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4064

#

4065

#

4066

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4067

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4068

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4069

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4070

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4071

# **JSON example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4072

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4073

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4074

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4075

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4076

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4077

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4078

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4079

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4080

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4081

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

4082

#

4083

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

4084

#

4085

# Example Policy with multiple AuditConfigs:

4086

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4087

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4088

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4089

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4090

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4091

{ # Provides the configuration for logging a type of permissions. Example:

4092

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4093

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4094

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4095

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4096

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4097

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4098

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4099

"ignoreChildExemptions": True or False,

4100

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4101

},

4102

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4107

},

4108

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4109

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4110

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

4111

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4112

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

4113

#

4114

# If the condition evaluates to `true`, then this binding applies to the current request.

4115

#

4116

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

4117

#

4118

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4119

#

4120

# Example (Comparison):

4121

#

4122

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4123

#

4124

# Example (Equality):

4125

#

4126

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

4131

#

4132

# Example (Data Manipulation):

4133

#

4134

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4135

#

4136

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

4137

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

4138

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4139

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

4140

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

4141

},

4142

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4143

#

4144

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4145

#

4146

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4147

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4148

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

4153

#

4154

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4155

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4156

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

4157

#

4158

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

4159

#

4160

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

4161

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4162

#

4163

#

4164

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4165

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4166

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4167

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4168

},

4169

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4170

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

4171

#

4172

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

4173

"iamOwned": True or False,

4174

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

4175

{ # A rule to be applied in a Policy.

4176

"action": "A String", # Required

4177

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

4178

{ # A condition to be met.

4179

"iam": "A String", # Trusted attributes supplied by the IAM system.

4180

"op": "A String", # An operator to apply the subject with.

4181

"svc": "A String", # Trusted attributes discharged by the service.

4182

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

4183

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

4189

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

4190

"A String",

4191

],

4192

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

4193

{ # Specifies what kind of log the caller must write

4194

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

4195

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

4196

"permissionType": "A String", # The type of the permission that was checked.

4197

},

4198

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

4199

},

4200

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

4201

#

4202

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

4203

#

4204

# Field names correspond to IAM request parameters and field values are their respective values.

4205

#

4206

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

4207

#

4208

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

4209

"customFields": [ # Custom fields.

4210

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

4211

"name": "A String", # Name is the field name.

4212

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

4213

},

4214

],

4215

"field": "A String", # The field value to attribute.

4216

"metric": "A String", # The metric to update.

4217

},

4218

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

4219

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

4224

"A String",

4225

],

4226

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

4232

#

4233

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

4234

#

4235

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

4236

#

4237

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

4238

#

4239

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

4240

#

4241

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

4242

#

4243

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

}

Returns:

An object of the form:

4250

4251

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

4256

#

4257

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

4266

#

4267

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

4268

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

4269

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

4270

#

4271

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

4272

#

4273

# Example Policy with multiple AuditConfigs:

4274

#

4275

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

4276

#

4277

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

4278

"auditLogConfigs": [ # The configuration for logging of each type of permission.

4279

{ # Provides the configuration for logging a type of permissions. Example:

4280

#

4281

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

4282

#

4283

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

4284

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

4285

"A String",

4286

],

4287

"ignoreChildExemptions": True or False,

4288

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

4295

},

4296

],

4297

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

4298

{ # Associates `members` with a `role`.

4299

"bindingId": "A String",

4300

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

4301

#

4302

# If the condition evaluates to `true`, then this binding applies to the current request.

4303

#

4304

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

4305

#

4306

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4307

#

4308

# Example (Comparison):

4309

#

4310

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4311

#

4312

# Example (Equality):

4313

#

4314

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

4319

#

4320

# Example (Data Manipulation):

4321

#

4322

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

4323

#

4324

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

4325

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

4326

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4327

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

4328

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

4329

},

4330

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

4331

#

4332

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

4333

#

4334

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

4335

#

4336

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

4341

#

4342

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

4343

#

4344

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

4345

#

4346

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

4347

#

4348

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

4353

"A String",

4354

],

4355

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

4356

},

4357

],

4358

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

4359

#

4360

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

4361

"iamOwned": True or False,

4362

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

4363

{ # A rule to be applied in a Policy.

4364

"action": "A String", # Required

4365

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

4366

{ # A condition to be met.

4367

"iam": "A String", # Trusted attributes supplied by the IAM system.

4368

"op": "A String", # An operator to apply the subject with.

4369

"svc": "A String", # Trusted attributes discharged by the service.

4370

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

4371

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

4377

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

4378

"A String",

4379

],

4380

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

4381

{ # Specifies what kind of log the caller must write

4382

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

4383

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

4384

"permissionType": "A String", # The type of the permission that was checked.

4385

},

4386

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

4387

},

4388

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

4389

#

4390

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

4391

#

4392

# Field names correspond to IAM request parameters and field values are their respective values.

4393

#

4394

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

4395

#

4396

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

4397

"customFields": [ # Custom fields.

4398

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

4399

"name": "A String", # Name is the field name.

4400

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

4401

},

4402

],

4403

"field": "A String", # The field value to attribute.

4404

"metric": "A String", # The metric to update.

4405

},

4406

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

4407

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

4412

"A String",

4413

],

4414

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

4420

#

4421

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

4422

#

4423

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

4424

#

4425

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

4426

#

4427

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

4428

#

4429

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

4430

#

4431

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

4432

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4436

<code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4437

<pre>Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4438

4439

Args:

4440

project: string, Project ID for this request. (required)

4441

zone: string, The name of the zone for this request. (required)

4442

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4443

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4444

The object takes the form of:

4445

4446

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4447

"labelFingerprint": "A String", # Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.

"labels": {

"a_key": "A String",

},

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4452

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4453

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.

4454

4455

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.

4456

4457

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]

4458

4459

Returns:

4460

An object of the form:

4461

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4462

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4463

#

4464

# Google Compute Engine has three Operation resources:

4465

#

4466

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4467

#

4468

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4469

#

4470

# Operations can be global, regional or zonal.

4471

# - For global operations, use the `globalOperations` resource.

4472

# - For regional operations, use the `regionOperations` resource.

4473

# - For zonal operations, use the `zonalOperations` resource.

4474

#

4475

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4476

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4477

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4478

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4479

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4480

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4481

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4482

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4483

"code": "A String", # [Output Only] The error type identifier for this error.

4484

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4485

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4486

},

4487

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4488

},

4489

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4490

"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.

4491

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4492

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4493

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4494

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4495

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4496

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4497

"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.

4498

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4499

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4500

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4501

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4502

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4503

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4504

"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.

4505

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4506

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4507

{

4508

"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.

4509

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4510

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4511

{

4512

"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).

4513

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4514

},

4515

],

4516

"message": "A String", # [Output Only] A human-readable description of the warning code.

4517

},

4518

],

4519

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4520

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4524

<code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4525

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

4526

4527

Args:

4528

project: string, Project ID for this request. (required)

4529

zone: string, The name of the zone for this request. (required)

4530

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4531

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4532

The object takes the form of:

4533

4534

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4535

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

4536

{ # A specification of the type and number of accelerator cards attached to the instance.

4537

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4538

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

4539

},

4540

],

4541

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4542

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4543

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.

4544

4545

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.

4546

4547

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]

4548

4549

Returns:

4550

An object of the form:

4551

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4552

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4553

#

4554

# Google Compute Engine has three Operation resources:

4555

#

4556

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4557

#

4558

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4559

#

4560

# Operations can be global, regional or zonal.

4561

# - For global operations, use the `globalOperations` resource.

4562

# - For regional operations, use the `regionOperations` resource.

4563

# - For zonal operations, use the `zonalOperations` resource.

4564

#

4565

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4566

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4567

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4568

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4569

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4570

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4571

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4572

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4573

"code": "A String", # [Output Only] The error type identifier for this error.

4574

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4575

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4576

},

4577

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4578

},

4579

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4580

"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.

4581

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4582

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4583

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4584

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4585

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4586

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4587

"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.

4588

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4589

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4590

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4591

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4592

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4593

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4594

"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.

4595

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4596

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4597

{

4598

"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.

4599

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4600

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4601

{

4602

"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).

4603

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4604

},

4605

],

4606

"message": "A String", # [Output Only] A human-readable description of the warning code.

4607

},

4608

],

4609

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4610

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4614

<code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4615

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

4616

4617

Args:

4618

project: string, Project ID for this request. (required)

4619

zone: string, The name of the zone for this request. (required)

4620

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4621

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4622

The object takes the form of:

4623

4624

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4625

"machineType": "A String", # Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1

4626

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4627

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4628

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.

4629

4630

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.

4631

4632

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]

4633

4634

Returns:

4635

An object of the form:

4636

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4637

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4638

#

4639

# Google Compute Engine has three Operation resources:

4640

#

4641

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4642

#

4643

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4644

#

4645

# Operations can be global, regional or zonal.

4646

# - For global operations, use the `globalOperations` resource.

4647

# - For regional operations, use the `regionOperations` resource.

4648

# - For zonal operations, use the `zonalOperations` resource.

4649

#

4650

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4651

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4652

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4653

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4654

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4655

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4656

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4657

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4658

"code": "A String", # [Output Only] The error type identifier for this error.

4659

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4660

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4661

},

4662

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4663

},

4664

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4665

"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.

4666

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4667

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4668

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4669

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4670

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4671

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4672

"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.

4673

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4674

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4675

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4676

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4677

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4678

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4679

"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.

4680

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4681

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4682

{

4683

"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.

4684

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4685

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4686

{

4687

"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).

4688

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4689

},

4690

],

4691

"message": "A String", # [Output Only] A human-readable description of the warning code.

4692

},

4693

],

4694

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4695

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4699

<code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4700

<pre>Sets metadata for the specified instance to the data included in the request.

4701

4702

Args:

4703

project: string, Project ID for this request. (required)

4704

zone: string, The name of the zone for this request. (required)

4705

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4706

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4707

The object takes the form of:

4708

4709

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4710

"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]

4711

#

4712

# 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]

4713

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4714

{

4715

"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.

4716

"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).

4717

},

4718

],

4719

"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]

4720

}

4721

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4722

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.

4723

4724

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.

4725

4726

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]

4727

4728

Returns:

4729

An object of the form:

4730

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4731

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4732

#

4733

# Google Compute Engine has three Operation resources:

4734

#

4735

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4736

#

4737

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4738

#

4739

# Operations can be global, regional or zonal.

4740

# - For global operations, use the `globalOperations` resource.

4741

# - For regional operations, use the `regionOperations` resource.

4742

# - For zonal operations, use the `zonalOperations` resource.

4743

#

4744

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4745

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4746

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4747

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4748

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4749

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4750

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4751

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4752

"code": "A String", # [Output Only] The error type identifier for this error.

4753

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4754

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4755

},

4756

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4757

},

4758

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4759

"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.

4760

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4761

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4762

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4763

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4764

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4765

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4766

"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.

4767

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4768

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4769

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4770

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4771

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4772

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4773

"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.

4774

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4775

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4776

{

4777

"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.

4778

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4779

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4780

{

4781

"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).

4782

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4783

},

4784

],

4785

"message": "A String", # [Output Only] A human-readable description of the warning code.

4786

},

4787

],

4788

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4789

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4793

<code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4794

<pre>Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4795

4796

Args:

4797

project: string, Project ID for this request. (required)

4798

zone: string, The name of the zone for this request. (required)

4799

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4800

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4801

The object takes the form of:

4802

4803

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4804

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

4805

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4806

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4807

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.

4808

4809

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.

4810

4811

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4812

4813

Returns:

4814

An object of the form:

4815

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4816

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4817

#

4818

# Google Compute Engine has three Operation resources:

4819

#

4820

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4821

#

4822

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4823

#

4824

# Operations can be global, regional or zonal.

4825

# - For global operations, use the `globalOperations` resource.

4826

# - For regional operations, use the `regionOperations` resource.

4827

# - For zonal operations, use the `zonalOperations` resource.

4828

#

4829

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4830

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4831

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4832

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4833

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4834

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4835

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4836

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4837

"code": "A String", # [Output Only] The error type identifier for this error.

4838

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4839

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4840

},

4841

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4842

},

4843

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4844

"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.

4845

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4846

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4847

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4848

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4849

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4850

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4851

"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.

4852

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4853

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4854

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4855

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4856

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4857

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4858

"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.

4859

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4860

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4861

{

4862

"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.

4863

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4864

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4865

{

4866

"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).

4867

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4868

},

4869

],

4870

"message": "A String", # [Output Only] A human-readable description of the warning code.

4871

},

4872

],

4873

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4874

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4878

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>

4879

<pre>Sets name of an instance.

4880

4881

Args:

4882

project: string, Project ID for this request. (required)

4883

zone: string, The name of the zone for this request. (required)

4884

instance: string, The instance name for this request. (required)

4885

body: object, The request body.

4886

The object takes the form of:

4887

4888

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4889

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

4890

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

4891

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4892

4893

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.

4894

4895

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.

4896

4897

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4898

4899

Returns:

4900

An object of the form:

4901

4902

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4903

#

4904

# Google Compute Engine has three Operation resources:

4905

#

4906

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4907

#

4908

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4909

#

4910

# Operations can be global, regional or zonal.

4911

# - For global operations, use the `globalOperations` resource.

4912

# - For regional operations, use the `regionOperations` resource.

4913

# - For zonal operations, use the `zonalOperations` resource.

4914

#

4915

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4916

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4917

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4918

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4919

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4920

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4921

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4922

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4923

"code": "A String", # [Output Only] The error type identifier for this error.

4924

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4925

"message": "A String", # [Output Only] An optional, human-readable error message.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4926

},

4927

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4928

},

4929

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4930

"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.

4931

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4932

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4933

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4934

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4935

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4936

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4937

"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.

4938

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4939

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4940

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4941

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4942

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4943

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4944

"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.

4945

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4946

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4947

{

4948

"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.

4949

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4950

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4951

{

4952

"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).

4953

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4954

},

4955

],

4956

"message": "A String", # [Output Only] A human-readable description of the warning code.

4957

},

4958

],

4959

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4960

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4964

<code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4965

<pre>Sets an instance's scheduling options. You can only call this method on a stopped instance, that is, a VM instance that is in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4966

4967

Args:

4968

project: string, Project ID for this request. (required)

4969

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4970

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4971

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4972

The object takes the form of:

4973

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4974

{ # Sets the scheduling options for an Instance. NextID: 20

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4975

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4976

#

4977

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4978

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

4979

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

4980

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4981

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4982

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4983

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4984

"key": "A String", # Corresponds to the label key of Node resource.

4985

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4986

"values": [ # Corresponds to the label values of Node resource.

4987

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4988

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4989

},

4990

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4991

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4992

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4993

}

4994

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4995

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.

4996

4997

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.

4998

4999

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]

5000

5001

Returns:

5002

An object of the form:

5003

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5004

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5005

#

5006

# Google Compute Engine has three Operation resources:

5007

#

5008

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5009

#

5010

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5011

#

5012

# Operations can be global, regional or zonal.

5013

# - For global operations, use the `globalOperations` resource.

5014

# - For regional operations, use the `regionOperations` resource.

5015

# - For zonal operations, use the `zonalOperations` resource.

5016

#

5017

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5018

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5019

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5020

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5021

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5022

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5023

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5024

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5025

"code": "A String", # [Output Only] The error type identifier for this error.

5026

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5027

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5028

},

5029

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5030

},

5031

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5032

"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.

5033

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5034

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5035

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5036

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5037

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5038

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5039

"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.

5040

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5041

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5042

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5043

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5044

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5045

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5046

"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.

5047

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5048

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5049

{

5050

"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.

5051

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5052

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5053

{

5054

"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).

5055

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5056

},

5057

],

5058

"message": "A String", # [Output Only] A human-readable description of the warning code.

5059

},

5060

],

5061

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5062

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5066

<code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5067

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5068

5069

Args:

5070

project: string, Project ID for this request. (required)

5071

zone: string, The name of the zone for this request. (required)

5072

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5073

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5074

The object takes the form of:

5075

5076

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5077

"email": "A String", # Email address of the service account.

5078

"scopes": [ # The list of scopes to be made available for this service account.

5079

"A String",

5080

],

5081

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5082

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5083

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.

5084

5085

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.

5086

5087

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5088

5089

Returns:

5090

An object of the form:

5091

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5092

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5093

#

5094

# Google Compute Engine has three Operation resources:

5095

#

5096

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5097

#

5098

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5099

#

5100

# Operations can be global, regional or zonal.

5101

# - For global operations, use the `globalOperations` resource.

5102

# - For regional operations, use the `regionOperations` resource.

5103

# - For zonal operations, use the `zonalOperations` resource.

5104

#

5105

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5106

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5107

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5108

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5109

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5110

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5111

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5112

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5113

"code": "A String", # [Output Only] The error type identifier for this error.

5114

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5115

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5116

},

5117

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5118

},

5119

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5120

"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.

5121

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5122

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5123

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5124

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5125

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5126

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5127

"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.

5128

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5129

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5130

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5131

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5132

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5133

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5134

"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.

5135

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5136

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5137

{

5138

"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.

5139

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5140

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5141

{

5142

"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).

5143

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5144

},

5145

],

5146

"message": "A String", # [Output Only] A human-readable description of the warning code.

5147

},

5148

],

5149

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5150

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5154

<code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5155

<pre>Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

5156

5157

Args:

5158

project: string, Project ID for this request. (required)

5159

zone: string, The name of the zone for this request. (required)

5160

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5161

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5162

The object takes the form of:

5163

5164

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5165

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5166

}

5167

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5168

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.

5169

5170

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.

5171

5172

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]

5173

5174

Returns:

5175

An object of the form:

5176

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5177

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5178

#

5179

# Google Compute Engine has three Operation resources:

5180

#

5181

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5182

#

5183

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5184

#

5185

# Operations can be global, regional or zonal.

5186

# - For global operations, use the `globalOperations` resource.

5187

# - For regional operations, use the `regionOperations` resource.

5188

# - For zonal operations, use the `zonalOperations` resource.

5189

#

5190

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5191

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5192

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5193

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5194

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5195

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5196

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5197

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5198

"code": "A String", # [Output Only] The error type identifier for this error.

5199

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5200

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5201

},

5202

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5203

},

5204

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5205

"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.

5206

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5207

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5208

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5209

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5210

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5211

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5212

"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.

5213

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5214

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5215

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5216

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5217

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5218

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5219

"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.

5220

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5221

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5222

{

5223

"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.

5224

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5225

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5226

{

5227

"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).

5228

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5229

},

5230

],

5231

"message": "A String", # [Output Only] A human-readable description of the warning code.

5232

},

5233

],

5234

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5235

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

<code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>

5240

<pre>Sets the Shielded VM integrity policy for a VM instance. You can only use this method on a running VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

5241

5242

Args:

5243

project: string, Project ID for this request. (required)

5244

zone: string, The name of the zone for this request. (required)

5245

instance: string, Name of the instance scoping this request. (required)

5246

body: object, The request body.

5247

The object takes the form of:

5248

5249

{ # The policy describes the baseline against which VM instance boot integrity is measured.

5250

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5251

}

5252

5253

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.

5254

5255

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.

5256

5257

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5258

5259

Returns:

5260

An object of the form:

5261

5262

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5263

#

5264

# Google Compute Engine has three Operation resources:

5265

#

5266

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5267

#

5268

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5269

#

5270

# Operations can be global, regional or zonal.

5271

# - For global operations, use the `globalOperations` resource.

5272

# - For regional operations, use the `regionOperations` resource.

5273

# - For zonal operations, use the `zonalOperations` resource.

5274

#

5275

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5276

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5277

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5278

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5279

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5280

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5281

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5282

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5283

"code": "A String", # [Output Only] The error type identifier for this error.

5284

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5285

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5286

},

5287

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5288

},

5289

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5290

"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.

5291

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5292

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5293

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5294

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5295

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5296

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5297

"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.

5298

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5299

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5300

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5301

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5302

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5303

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5304

"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.

5305

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5306

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5307

{

5308

"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.

5309

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5310

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5311

{

5312

"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).

5313

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5314

},

5315

],

5316

"message": "A String", # [Output Only] A human-readable description of the warning code.

5317

},

5318

],

5319

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5320

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

<code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None)</code>

5325

<pre>Sets network tags for the specified instance to the data included in the request.

5326

5327

Args:

5328

project: string, Project ID for this request. (required)

5329

zone: string, The name of the zone for this request. (required)

5330

instance: string, Name of the instance scoping this request. (required)

5331

body: object, The request body.

5332

The object takes the form of:

5333

5334

{ # A set of instance tags.

5335

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

5336

#

5337

# To see the latest fingerprint, make get() request to the instance.

5338

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

}

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.

5344

5345

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.

5346

5347

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5348

5349

Returns:

5350

An object of the form:

5351

5352

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5353

#

5354

# Google Compute Engine has three Operation resources:

5355

#

5356

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5357

#

5358

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5359

#

5360

# Operations can be global, regional or zonal.

5361

# - For global operations, use the `globalOperations` resource.

5362

# - For regional operations, use the `regionOperations` resource.

5363

# - For zonal operations, use the `zonalOperations` resource.

5364

#

5365

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5366

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5367

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5368

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5369

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5370

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5371

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5372

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5373

"code": "A String", # [Output Only] The error type identifier for this error.

5374

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5375

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5376

},

5377

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5378

},

5379

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5380

"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.

5381

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5382

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5383

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5384

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5385

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5386

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5387

"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.

5388

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5389

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5390

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5391

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5392

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5393

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5394

"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.

5395

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5396

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5397

{

5398

"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.

5399

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5400

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5401

{

5402

"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).

5403

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5404

},

5405

],

5406

"message": "A String", # [Output Only] A human-readable description of the warning code.

5407

},

5408

],

5409

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5410

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5414

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

5415

<pre>Simulates a maintenance event on the instance.

5416

5417

Args:

5418

project: string, Project ID for this request. (required)

5419

zone: string, The name of the zone for this request. (required)

5420

instance: string, Name of the instance scoping this request. (required)

5421

5422

Returns:

5423

An object of the form:

5424

5425

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5426

#

5427

# Google Compute Engine has three Operation resources:

5428

#

5429

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5430

#

5431

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5432

#

5433

# Operations can be global, regional or zonal.

5434

# - For global operations, use the `globalOperations` resource.

5435

# - For regional operations, use the `regionOperations` resource.

5436

# - For zonal operations, use the `zonalOperations` resource.

5437

#

5438

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5439

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5440

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5441

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5442

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5443

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5444

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5445

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5446

"code": "A String", # [Output Only] The error type identifier for this error.

5447

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5448

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5449

},

5450

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5451

},

5452

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5453

"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.

5454

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5455

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5456

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5457

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5458

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5459

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5460

"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.

5461

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5462

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5463

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5464

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5465

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5466

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5467

"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.

5468

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5469

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5470

{

5471

"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.

5472

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5473

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5474

{

5475

"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).

5476

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5477

},

5478

],

5479

"message": "A String", # [Output Only] A human-readable description of the warning code.

5480

},

5481

],

5482

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5483

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="start">start(project, zone, instance, requestId=None)</code>

5488

<pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5489

5490

Args:

5491

project: string, Project ID for this request. (required)

5492

zone: string, The name of the zone for this request. (required)

5493

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5494

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.

5495

5496

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.

5497

5498

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]

5499

5500

Returns:

5501

An object of the form:

5502

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5503

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5504

#

5505

# Google Compute Engine has three Operation resources:

5506

#

5507

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5508

#

5509

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5510

#

5511

# Operations can be global, regional or zonal.

5512

# - For global operations, use the `globalOperations` resource.

5513

# - For regional operations, use the `regionOperations` resource.

5514

# - For zonal operations, use the `zonalOperations` resource.

5515

#

5516

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5517

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5518

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5519

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5520

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5521

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5522

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5523

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5524

"code": "A String", # [Output Only] The error type identifier for this error.

5525

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5526

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5527

},

5528

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5529

},

5530

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5531

"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.

5532

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5533

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5534

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5535

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5536

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5537

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5538

"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.

5539

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5540

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5541

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5542

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5543

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5544

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5545

"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.

5546

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5547

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5548

{

5549

"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.

5550

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5551

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5552

{

5553

"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).

5554

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5555

},

5556

],

5557

"message": "A String", # [Output Only] A human-readable description of the warning code.

5558

},

5559

],

5560

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5561

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5565

<code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5566

<pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5567

5568

Args:

5569

project: string, Project ID for this request. (required)

5570

zone: string, The name of the zone for this request. (required)

5571

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5572

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5573

The object takes the form of:

5574

5575

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5576

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

5577

#

5578

# In order to start the instance, the disk url and its corresponding key must be provided.

5579

#

5580

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

5581

{

5582

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

5583

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5584

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5585

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5586

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5587

#

5588

# The key must meet the following requirements before you can provide it to Compute Engine:

5589

# - The key is wrapped using a RSA public key certificate provided by Google.

5590

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5591

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5592

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5593

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5594

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

5595

},

5596

],

5597

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5598

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5599

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.

5600

5601

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.

5602

5603

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]

5604

5605

Returns:

5606

An object of the form:

5607

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5608

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5609

#

5610

# Google Compute Engine has three Operation resources:

5611

#

5612

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5613

#

5614

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5615

#

5616

# Operations can be global, regional or zonal.

5617

# - For global operations, use the `globalOperations` resource.

5618

# - For regional operations, use the `regionOperations` resource.

5619

# - For zonal operations, use the `zonalOperations` resource.

5620

#

5621

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5622

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5623

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5624

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5625

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5626

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5627

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5628

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5629

"code": "A String", # [Output Only] The error type identifier for this error.

5630

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5631

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5632

},

5633

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5634

},

5635

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5636

"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.

5637

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5638

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5639

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5640

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5641

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5642

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5643

"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.

5644

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5645

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5646

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5647

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5648

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5649

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5650

"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.

5651

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5652

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5653

{

5654

"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.

5655

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5656

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5657

{

5658

"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).

5659

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5660

},

5661

],

5662

"message": "A String", # [Output Only] A human-readable description of the warning code.

5663

},

5664

],

5665

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5666

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5670

<code class="details" id="stop">stop(project, zone, instance, requestId=None)</code>

5671

<pre>Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5672

5673

Args:

5674

project: string, Project ID for this request. (required)

5675

zone: string, The name of the zone for this request. (required)

5676

instance: string, Name of the instance resource to stop. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5677

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.

5678

5679

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.

5680

5681

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]

5682

5683

Returns:

5684

An object of the form:

5685

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5686

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5687

#

5688

# Google Compute Engine has three Operation resources:

5689

#

5690

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5691

#

5692

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5693

#

5694

# Operations can be global, regional or zonal.

5695

# - For global operations, use the `globalOperations` resource.

5696

# - For regional operations, use the `regionOperations` resource.

5697

# - For zonal operations, use the `zonalOperations` resource.

5698

#

5699

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5700

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5701

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5702

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5703

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5704

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5705

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5706

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5707

"code": "A String", # [Output Only] The error type identifier for this error.

5708

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5709

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5710

},

5711

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5712

},

5713

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5714

"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.

5715

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5716

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5717

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5718

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5719

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5720

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5721

"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.

5722

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5723

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5724

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5725

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5726

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5727

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5728

"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.

5729

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5730

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5731

{

5732

"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.

5733

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5734

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5735

{

5736

"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).

5737

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5738

},

5739

],

5740

"message": "A String", # [Output Only] A human-readable description of the warning code.

5741

},

5742

],

5743

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5744

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</code>

5749

<pre>This method suspends a running instance, saving its state to persistent storage, and allows you to resume the instance at a later time. Suspended instances incur reduced per-minute, virtual machine usage charges while they are suspended. Any resources the virtual machine is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted.

5750

5751

Args:

5752

project: string, Project ID for this request. (required)

5753

zone: string, The name of the zone for this request. (required)

5754

instance: string, Name of the instance resource to suspend. (required)

5755

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

5756

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.

5757

5758

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.

5759

5760

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5761

5762

Returns:

5763

An object of the form:

5764

5765

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5766

#

5767

# Google Compute Engine has three Operation resources:

5768

#

5769

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5770

#

5771

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5772

#

5773

# Operations can be global, regional or zonal.

5774

# - For global operations, use the `globalOperations` resource.

5775

# - For regional operations, use the `regionOperations` resource.

5776

# - For zonal operations, use the `zonalOperations` resource.

5777

#

5778

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5779

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5780

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5781

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5782

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5783

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5784

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5785

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5786

"code": "A String", # [Output Only] The error type identifier for this error.

5787

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5788

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5789

},

5790

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5791

},

5792

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5793

"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.

5794

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5795

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5796

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5797

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5798

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5799

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5800

"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.

5801

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5802

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5803

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5804

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5805

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5806

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5807

"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.

5808

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5809

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5810

{

5811

"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.

5812

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5813

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5814

{

5815

"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).

5816

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5817

},

5818

],

5819

"message": "A String", # [Output Only] A human-readable description of the warning code.

5820

},

5821

],

5822

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5823

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5827

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5828

<pre>Returns permissions that a caller has on the specified resource.

5829

5830

Args:

5831

project: string, Project ID for this request. (required)

5832

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5833

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5834

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5835

The object takes the form of:

5836

5837

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5838

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

5839

"A String",

5840

],

5841

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

5846

5847

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5848

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

5849

"A String",

5850

],

5851

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5852

</div>

5853

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5854

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5855

<code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5856

<pre>Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.

5857

5858

Args:

5859

project: string, Project ID for this request. (required)

5860

zone: string, The name of the zone for this request. (required)

5861

instance: string, Name of the instance resource to update. (required)

5862

body: object, The request body.

5863

The object takes the form of:

5864

5865

{ # Represents an Instance resource.

5866

#

5867

# An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5868

"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). # Controls for advanced machine-related behavior features.

5869

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

5870

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5871

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5872

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5873

"confidentialInstanceConfig": { # A set of Confidential Instance options.

5874

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

5875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5876

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

5877

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5878

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

5879

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5880

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5881

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5882

"autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

5883

"boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

5884

"deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

5885

#

5886

# If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5887

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5888

#

5889

# If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

5890

#

5891

# If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

5892

#

5893

# If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

5894

#

5895

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5896

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5897

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5898

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5899

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5900

#

5901

# The key must meet the following requirements before you can provide it to Compute Engine:

5902

# - The key is wrapped using a RSA public key certificate provided by Google.

5903

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5904

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5905

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5906

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5907

"diskSizeGb": "A String", # The size of the disk in GB.

5908

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

5909

{ # Guest OS features.

5910

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

5911

},

5912

],

5913

"index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

5914

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5915

#

5916

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

5917

#

5918

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5919

"description": "A String", # An optional description. Provide this property when creating the disk.

5920

"diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

5921

"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

5922

"diskType": "A String", # Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5923

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

5924

#

5925

#

5926

# Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

5927

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

5928

# - projects/project/zones/zone/diskTypes/diskType

5929

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5930

"guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5931

#

5932

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

5933

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5934

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5935

},

5936

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5937

"labels": { # Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

5938

"a_key": "A String",

5939

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5940

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5941

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5942

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5943

"resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

5944

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5945

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5946

"sourceImage": "A String", # The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5947

#

5948

# To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:

5949

# projects/debian-cloud/global/images/family/debian-9

5950

#

5951

#

5952

# Alternatively, use a specific version of a public operating system image:

5953

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

5954

#

5955

#

5956

# To create a disk with a custom image that you created, specify the image name in the following format:

5957

# global/images/my-custom-image

5958

#

5959

#

5960

# You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

5961

# global/images/family/my-image-family

5962

#

5963

#

5964

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5965

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5966

#

5967

# Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

5968

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5969

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5970

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5971

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5972

#

5973

# The key must meet the following requirements before you can provide it to Compute Engine:

5974

# - The key is wrapped using a RSA public key certificate provided by Google.

5975

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5976

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5977

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5978

},

5979

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.

5980

#

5981

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

5982

# global/snapshots/my-backup

5983

#

5984

#

5985

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5986

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5987

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

5988

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

5989

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

5990

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

5991

#

5992

# The key must meet the following requirements before you can provide it to Compute Engine:

5993

# - The key is wrapped using a RSA public key certificate provided by Google.

5994

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

5995

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

5996

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5997

},

5998

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5999

"interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.

6000

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

6001

"licenses": [ # [Output Only] Any valid publicly visible licenses.

6002

"A String",

6003

],

6004

"mode": "A String", # The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.

6005

"shieldedInstanceInitialState": { # Initial State for shielded instance, these are public keys which are safe to store in public # [Output Only] shielded vm initial state stored on disk

6006

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6007

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6008

"content": "A String", # The raw content in the secure keys file.

6009

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6010

},

6011

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6012

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6013

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6014

"content": "A String", # The raw content in the secure keys file.

6015

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6016

},

6017

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6018

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6019

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6020

"content": "A String", # The raw content in the secure keys file.

6021

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6022

},

6023

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6024

"pk": { # The Platform Key (PK).

6025

"content": "A String", # The raw content in the secure keys file.

6026

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6027

},

6028

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6029

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6030

#

6031

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

6032

#

6033

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6034

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6035

},

6036

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6037

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

6038

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

6039

},

6040

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

6041

"fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.

6042

#

6043

# To see the latest fingerprint, make get() request to the instance.

6044

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

6045

{ # A specification of the type and number of accelerator cards attached to the instance.

6046

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

6047

"acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.

6048

},

6049

],

6050

"hostname": "A String", # Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

6051

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

6052

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

6053

"labelFingerprint": "A String", # A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

6054

#

6055

# To see the latest fingerprint, make get() request to the instance.

6056

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

6057

"a_key": "A String",

6058

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6059

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

6060

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

6061

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6062

"machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:

6063

# zones/us-central1-f/machineTypes/n1-standard-1

6064

#

6065

#

6066

# To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):

6067

# zones/zone/machineTypes/custom-CPUS-MEMORY

6068

#

6069

#

6070

# For example: zones/us-central1-f/machineTypes/custom-4-5120

6071

#

6072

# For a full list of restrictions, read the Specifications for custom machine types.

6073

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

6074

"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.

6075

#

6076

# To see the latest fingerprint, make a get() request to retrieve the resource.

6077

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

6078

{

6079

"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.

6080

"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).

6081

},

6082

],

6083

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

6084

},

6085

"minCpuPlatform": "A String", # Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".

6086

"name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

6087

"networkInterfaces": [ # An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

6088

{ # A network interface resource attached to an instance.

6089

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

6090

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6091

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6092

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

6093

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

6094

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

6095

#

6096

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6097

#

6098

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

6099

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6100

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

6101

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6102

},

6103

],

6104

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6105

{ # An alias IP range attached to an instance's network interface.

6106

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

6107

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

6108

},

6109

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6110

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6111

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6112

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6113

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

6114

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

6115

#

6116

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6117

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6118

# - projects/project/global/networks/network

6119

# - global/networks/default

6120

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6121

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6122

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

6123

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6124

# - regions/region/subnetworks/subnetwork

6125

},

6126

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6127

"networkPerformanceConfig": {

6128

"totalEgressBandwidthTier": "A String",

6129

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6130

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6131

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

6132

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

6133

"consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.

6134

"key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

6135

"values": [ # Corresponds to the label values of a reservation resource.

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

6140

"A String",

6141

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6142

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6143

"scheduling": { # Sets the scheduling options for an Instance. NextID: 20 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6144

"automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.

6145

#

6146

# By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6147

"locationHint": "A String", # An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

6148

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

6149

"maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6150

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

6151

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

6152

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

6153

"key": "A String", # Corresponds to the label key of Node resource.

6154

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

6155

"values": [ # Corresponds to the label values of Node resource.

"A String",

],

},

],

"onHostMaintenance": "A String", # Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6161

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6162

},

6163

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

6164

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

6165

#

6166

# Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

6167

{ # A service account.

6168

"email": "A String", # Email address of the service account.

6169

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

6175

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6176

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6177

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

6178

},

6179

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

6180

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

6181

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6182

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6183

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6184

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6185

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

6186

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6187

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6188

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

6189

},

6190

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6191

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6192

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6193

"kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

6194

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6195

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6196

#

6197

# The key must meet the following requirements before you can provide it to Compute Engine:

6198

# - The key is wrapped using a RSA public key certificate provided by Google.

6199

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6200

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6201

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6202

},

6203

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6204

"status": "A String", # [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6205

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

6206

"tags": { # A set of instance tags. # Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

6207

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

6208

#

6209

# To see the latest fingerprint, make get() request to the instance.

6210

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6215

}

6216

6217

minimalAction: string, Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.

Allowed values

INVALID -

NO_EFFECT -

REFRESH -

RESTART -

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6223

mostDisruptiveAllowedAction: string, Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.

Allowed values

INVALID -

NO_EFFECT -

REFRESH -

RESTART -

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6229

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.

6230

6231

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.

6232

6233

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6234

6235

Returns:

6236

An object of the form:

6237

6238

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6239

#

6240

# Google Compute Engine has three Operation resources:

6241

#

6242

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6243

#

6244

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6245

#

6246

# Operations can be global, regional or zonal.

6247

# - For global operations, use the `globalOperations` resource.

6248

# - For regional operations, use the `regionOperations` resource.

6249

# - For zonal operations, use the `zonalOperations` resource.

6250

#

6251

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6252

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6253

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6254

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6255

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6256

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6257

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6258

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6259

"code": "A String", # [Output Only] The error type identifier for this error.

6260

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6261

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6262

},

6263

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6264

},

6265

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6266

"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.

6267

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6268

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6269

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6270

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6271

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6272

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6273

"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.

6274

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6275

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6276

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6277

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6278

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6279

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6280

"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.

6281

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6282

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6283

{

6284

"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.

6285

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6286

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6287

{

6288

"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).

6289

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6290

},

6291

],

6292

"message": "A String", # [Output Only] A human-readable description of the warning code.

6293

},

6294

],

6295

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6296

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

<code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6301

<pre>Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6302

6303

Args:

6304

project: string, Project ID for this request. (required)

6305

zone: string, The name of the zone for this request. (required)

6306

instance: string, The instance name for this request. (required)

6307

networkInterface: string, The name of the network interface where the access config is attached. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6308

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6309

The object takes the form of:

6310

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6311

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6312

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6313

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

6314

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

6315

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6316

#

6317

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6318

#

6319

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6320

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6321

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

6322

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6323

}

6324

6325

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.

6326

6327

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.

6328

6329

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6330

6331

Returns:

6332

An object of the form:

6333

6334

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6335

#

6336

# Google Compute Engine has three Operation resources:

6337

#

6338

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6339

#

6340

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6341

#

6342

# Operations can be global, regional or zonal.

6343

# - For global operations, use the `globalOperations` resource.

6344

# - For regional operations, use the `regionOperations` resource.

6345

# - For zonal operations, use the `zonalOperations` resource.

6346

#

6347

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6348

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6349

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6350

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6351

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6352

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6353

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6354

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6355

"code": "A String", # [Output Only] The error type identifier for this error.

6356

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6357

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6358

},

6359

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6360

},

6361

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6362

"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.

6363

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6364

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6365

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6366

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6367

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6368

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6369

"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.

6370

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6371

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6372

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6373

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6374

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6375

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6376

"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.

6377

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6378

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6379

{

6380

"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.

6381

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6382

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6383

{

6384

"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).

6385

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6386

},

6387

],

6388

"message": "A String", # [Output Only] A human-readable description of the warning code.

6389

},

6390

],

6391

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6392

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6396

<code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6397

<pre>Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

6398

6399

Args:

6400

project: string, Project ID for this request. (required)

6401

zone: string, The name of the zone for this request. (required)

6402

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6403

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6404

The object takes the form of:

6405

6406

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6407

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6408

}

6409

6410

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.

6411

6412

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.

6413

6414

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6415

6416

Returns:

6417

An object of the form:

6418

6419

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6420

#

6421

# Google Compute Engine has three Operation resources:

6422

#

6423

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6424

#

6425

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6426

#

6427

# Operations can be global, regional or zonal.

6428

# - For global operations, use the `globalOperations` resource.

6429

# - For regional operations, use the `regionOperations` resource.

6430

# - For zonal operations, use the `zonalOperations` resource.

6431

#

6432

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6433

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6434

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6435

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6436

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6437

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6438

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6439

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6440

"code": "A String", # [Output Only] The error type identifier for this error.

6441

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6442

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6443

},

6444

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6445

},

6446

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6447

"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.

6448

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6449

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6450

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6451

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6452

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6453

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6454

"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.

6455

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6456

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6457

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6458

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6459

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6460

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6461

"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.

6462

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6463

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6464

{

6465

"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.

6466

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6467

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6468

{

6469

"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).

6470

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6471

},

6472

],

6473

"message": "A String", # [Output Only] A human-readable description of the warning code.

6474

},

6475

],

6476

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6477

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6481

<code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6482

<pre>Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6483

6484

Args:

6485

project: string, Project ID for this request. (required)

6486

zone: string, The name of the zone for this request. (required)

6487

instance: string, The instance name for this request. (required)

6488

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6489

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6490

The object takes the form of:

6491

6492

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6493

"accessConfigs": [ # An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

6494

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6495

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6496

"name": "A String", # The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.

6497

"natIP": "A String", # An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.

6498

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6499

#

6500

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

6501

#

6502

# If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6503

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

6504

"setPublicPtr": True or False, # Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.

6505

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6506

},

6507

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6508

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6509

{ # An alias IP range attached to an instance's network interface.

6510

"ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).

6511

"subnetworkRangeName": "A String", # The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

6512

},

6513

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6514

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6515

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6516

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6517

"name": "A String", # [Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.

6518

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6519

#

6520

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

6521

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

6522

# - projects/project/global/networks/network

6523

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6524

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6525

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6526

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

6527

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

6528

# - regions/region/subnetworks/subnetwork

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6529

}

6530

6531

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.

6532

6533

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.

6534

6535

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6536

6537

Returns:

6538

An object of the form:

6539

6540

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6541

#

6542

# Google Compute Engine has three Operation resources:

6543

#

6544

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6545

#

6546

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6547

#

6548

# Operations can be global, regional or zonal.

6549

# - For global operations, use the `globalOperations` resource.

6550

# - For regional operations, use the `regionOperations` resource.

6551

# - For zonal operations, use the `zonalOperations` resource.

6552

#

6553

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6554

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6555

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6556

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6557

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6558

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6559

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6560

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6561

"code": "A String", # [Output Only] The error type identifier for this error.

6562

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6563

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6564

},

6565

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6566

},

6567

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6568

"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.

6569

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6570

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6571

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6572

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6573

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6574

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6575

"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.

6576

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6577

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6578

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6579

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6580

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6581

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6582

"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.

6583

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6584

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6585

{

6586

"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.

6587

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6588

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6589

{

6590

"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).

6591

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6592

},

6593

],

6594

"message": "A String", # [Output Only] A human-readable description of the warning code.

6595

},

6596

],

6597

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6598

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6602

<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6603

<pre>Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

6604

6605

Args:

6606

project: string, Project ID for this request. (required)

6607

zone: string, The name of the zone for this request. (required)

6608

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6609

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6610

The object takes the form of:

6611

6612

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6613

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6614

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6615

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6616

}

6617

6618

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.

6619

6620

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.

6621

6622

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6623

6624

Returns:

6625

An object of the form:

6626

6627

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6628

#

6629

# Google Compute Engine has three Operation resources:

6630

#

6631

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6632

#

6633

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6634

#

6635

# Operations can be global, regional or zonal.

6636

# - For global operations, use the `globalOperations` resource.

6637

# - For regional operations, use the `regionOperations` resource.

6638

# - For zonal operations, use the `zonalOperations` resource.

6639

#

6640

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6641

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6642

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6643

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6644

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6645

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6646

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6647

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6648

"code": "A String", # [Output Only] The error type identifier for this error.

6649

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6650

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6651

},

6652

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6653

},

6654

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6655

"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.

6656

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6657

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6658

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6659

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6660

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6661

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6662

"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.

6663

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6664

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6665

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6666

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6667

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6668

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6669

"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.

6670

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6671

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6672

{

6673

"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.

6674

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6675

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6676

{

6677

"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).

6678

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6679

},

6680

],

6681

"message": "A String", # [Output Only] A human-readable description of the warning code.

6682

},

6683

],

6684

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6685

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6689

<code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6690

<pre>Updates the Shielded VM config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

6691

6692

Args:

6693

project: string, Project ID for this request. (required)

6694

zone: string, The name of the zone for this request. (required)

6695

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6696

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6697

The object takes the form of:

6698

6699

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6700

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6701

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6702

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6703

}

6704

6705

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.

6706

6707

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.

6708

6709

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6710

6711

Returns:

6712

An object of the form:

6713

6714

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6715

#

6716

# Google Compute Engine has three Operation resources:

6717

#

6718

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6719

#

6720

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6721

#

6722

# Operations can be global, regional or zonal.

6723

# - For global operations, use the `globalOperations` resource.

6724

# - For regional operations, use the `regionOperations` resource.

6725

# - For zonal operations, use the `zonalOperations` resource.

6726

#

6727

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6728

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6729

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6730

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6731

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6732

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6733

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6734

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6735

"code": "A String", # [Output Only] The error type identifier for this error.

6736

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6737

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6738

},

6739

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6740

},

6741

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6742

"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.

6743

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6744

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6745

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6746

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6747

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot