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

2020-05-20 12:08:20 -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

Dan O'Meara

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

[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

Sai Cheemalapati

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

[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

Sai Cheemalapati

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

[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

Sai Cheemalapati

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

[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

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>

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

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

yoshi-code-bot

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

[diff] [blame]

132

<code><a href="#insert">insert(project, zone, body=None, requestId=None, secureTags=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

Bu Sun Kim

2020-05-20 12:08:20 -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

Bu Sun Kim

2020-05-20 12:08:20 -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>

Bu Sun Kim

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

[diff] [blame]

148

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

149

Sai Cheemalapati

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

[diff] [blame]

150

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

Bu Sun Kim

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

[diff] [blame]

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>

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

yoshi-code-bot

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

[diff] [blame]

156

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

157

<p class="firstline">TODO(b/180520210): Add IAM permission for this API. Sends diagnostic interrupt to the instance.</p>

158

Bu Sun Kim

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

[diff] [blame]

159

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

160

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

Sai Cheemalapati

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

[diff] [blame]

161

Sai Cheemalapati

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

[diff] [blame]

162

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

163

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

164

Dan O'Meara

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

[diff] [blame]

165

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

Sai Cheemalapati

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

[diff] [blame]

166

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

167

Dan O'Meara

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

[diff] [blame]

168

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

169

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

Sai Cheemalapati

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

[diff] [blame]

170

Dan O'Meara

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

[diff] [blame]

171

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

172

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

173

Dan O'Meara

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

[diff] [blame]

174

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

175

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

176

Dan O'Meara

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

[diff] [blame]

177

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

178

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

179

Dan O'Meara

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

[diff] [blame]

180

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

181

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

182

Dan O'Meara

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

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

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

Sai Cheemalapati

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

[diff] [blame]

185

Dan O'Meara

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

[diff] [blame]

186

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

187

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

188

Dan O'Meara

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

[diff] [blame]

189

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

190

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

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="#setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(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 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>

194

Dan O'Meara

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

[diff] [blame]

195

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

196

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

197

Dan O'Meara

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

[diff] [blame]

198

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

199

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

200

Sai Cheemalapati

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

[diff] [blame]

201

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

202

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

203

204

<code><a href="#start">start(project, zone, instance, 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>

Sai Cheemalapati

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

[diff] [blame]

206

Dan O'Meara

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

[diff] [blame]

207

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

208

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

Sai Cheemalapati

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

[diff] [blame]

209

Sai Cheemalapati

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

[diff] [blame]

210

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

Bu Sun Kim

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

[diff] [blame]

211

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

Sai Cheemalapati

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

[diff] [blame]

212

Sai Cheemalapati

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

[diff] [blame]

213

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

Sai Cheemalapati

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

[diff] [blame]

214

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

215

Dan O'Meara

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

[diff] [blame]

216

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

Sai Cheemalapati

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

[diff] [blame]

217

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

218

yoshi-code-bot

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

[diff] [blame]

219

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

Dan O'Meara

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

[diff] [blame]

220

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

221

222

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

223

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

224

Dan O'Meara

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

[diff] [blame]

225

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

226

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

Sai Cheemalapati

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

[diff] [blame]

227

Dan O'Meara

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

[diff] [blame]

228

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

229

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

230

Dan O'Meara

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

[diff] [blame]

231

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

232

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

233

Dan O'Meara

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

[diff] [blame]

234

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

235

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

236

<h3>Method Details</h3>

237

Dan O'Meara

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

[diff] [blame]

238

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

239

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

Sai Cheemalapati

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

[diff] [blame]

240

241

Args:

242

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

243

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

244

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

245

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]

246

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

247

The object takes the form of:

248

Bu Sun Kim

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

[diff] [blame]

249

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

Bu Sun Kim

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

[diff] [blame]

250

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

251

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

254

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

255

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

256

#

257

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

258

#

259

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

260

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

261

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

262

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

263

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

264

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

265

}

266

Bu Sun Kim

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

[diff] [blame]

267

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.

268

269

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.

270

271

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]

272

273

Returns:

274

An object of the form:

275

Bu Sun Kim

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

[diff] [blame]

276

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

277

#

278

# Google Compute Engine has three Operation resources:

279

#

280

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

281

#

282

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

283

#

284

# Operations can be global, regional or zonal.

285

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

286

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

287

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

288

#

289

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

290

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

291

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

292

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

293

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

294

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

295

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

Bu Sun Kim

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

[diff] [blame]

296

{

Yoshi Automation Bot

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

[diff] [blame]

297

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

298

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

299

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

Bu Sun Kim

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

[diff] [blame]

300

},

301

],

Yoshi Automation Bot

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

[diff] [blame]

302

},

303

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

304

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

305

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

306

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

307

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

308

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

yoshi-code-bot

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

[diff] [blame]

309

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

310

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

311

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

312

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

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

{

323

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

324

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

325

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

326

{

327

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

328

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

329

},

330

],

331

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

332

},

333

],

334

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

335

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

339

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

Bu Sun Kim

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

[diff] [blame]

340

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

341

342

Args:

343

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

344

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

345

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

Dan O'Meara

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

[diff] [blame]

346

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

347

The object takes the form of:

348

349

{

Yoshi Automation Bot

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

[diff] [blame]

350

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

351

"A String",

352

],

353

}

Bu Sun Kim

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

[diff] [blame]

354

355

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.

356

357

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.

358

359

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

360

361

Returns:

362

An object of the form:

363

364

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

365

#

366

# Google Compute Engine has three Operation resources:

367

#

368

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

369

#

370

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

371

#

372

# Operations can be global, regional or zonal.

373

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

374

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

375

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

376

#

377

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

378

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

379

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

380

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

381

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

382

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

383

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

Bu Sun Kim

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

[diff] [blame]

384

{

Yoshi Automation Bot

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

[diff] [blame]

385

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

386

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

387

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

Bu Sun Kim

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

[diff] [blame]

388

},

389

],

Yoshi Automation Bot

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

[diff] [blame]

390

},

391

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

392

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

393

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

394

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

395

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

396

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

yoshi-code-bot

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

[diff] [blame]

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

{

411

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

412

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

413

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

414

{

415

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

416

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

417

},

418

],

419

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

420

},

421

],

422

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

423

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

427

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

428

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

429

430

Args:

431

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

Dan O'Meara

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

[diff] [blame]

432

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]

433

Dan O'Meara

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

[diff] [blame]

434

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]

435

Dan O'Meara

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

[diff] [blame]

436

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]

437

Bu Sun Kim

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

[diff] [blame]

438

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]

439

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]

440

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

441

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

442

443

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.

444

445

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

446

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]

447

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]

448

449

Returns:

450

An object of the form:

451

452

{

Yoshi Automation Bot

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

[diff] [blame]

453

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

454

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

455

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

456

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

457

{ # Represents an Instance resource.

458

#

459

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

460

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

461

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

462

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

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

[diff] [blame]

463

"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-31 13:33:30 -0700

[diff] [blame]

464

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

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

[diff] [blame]

465

},

466

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

467

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

468

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

469

},

470

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

471

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

472

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

473

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

474

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

475

{ # An instance-attached disk resource.

476

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

477

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

478

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

479

#

480

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

481

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

482

#

483

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

484

#

485

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

486

#

487

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

488

#

489

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

490

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

491

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

492

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

493

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

494

#

Yoshi Automation Bot

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

[diff] [blame]

495

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

496

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

497

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

498

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

499

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

500

},

501

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

502

"forceAttach": True or False, # [Input Only] 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.

503

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

504

{ # Guest OS features.

505

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

506

},

507

],

508

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

509

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

510

#

511

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

512

#

513

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

514

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

515

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

516

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

517

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

518

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

Sai Cheemalapati

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

[diff] [blame]

519

#

Sai Cheemalapati

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

[diff] [blame]

520

#

Yoshi Automation Bot

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

[diff] [blame]

521

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

522

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

523

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

524

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

525

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

526

#

Yoshi Automation Bot

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

[diff] [blame]

527

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

528

{ # Guest OS features.

529

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

530

},

531

],

532

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

533

"a_key": "A String",

534

},

535

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

536

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

537

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

538

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

539

"A String",

540

],

541

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

542

"A String",

543

],

544

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

545

#

Yoshi Automation Bot

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

[diff] [blame]

546

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

547

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

548

#

549

#

550

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

551

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

552

#

553

#

554

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

555

# global/images/my-custom-image

556

#

557

#

558

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

559

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

560

#

561

#

562

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

563

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

564

#

565

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

566

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

567

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

568

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

569

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

570

#

571

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

572

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

573

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

574

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

Bu Sun Kim

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

[diff] [blame]

575

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

576

},

Yoshi Automation Bot

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

[diff] [blame]

577

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

578

#

Yoshi Automation Bot

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

[diff] [blame]

579

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

580

# global/snapshots/my-backup

Sai Cheemalapati

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

[diff] [blame]

581

#

Yoshi Automation Bot

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

[diff] [blame]

582

#

583

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

584

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

585

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

586

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

587

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

588

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

589

#

Yoshi Automation Bot

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

[diff] [blame]

590

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

591

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

592

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

593

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

594

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

595

},

Yoshi Automation Bot

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

[diff] [blame]

596

},

597

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

598

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

599

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

600

"A String",

601

],

602

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

603

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

604

"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

605

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

606

{

Bu Sun Kim

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

[diff] [blame]

607

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

608

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

Bu Sun Kim

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

[diff] [blame]

609

},

Yoshi Automation Bot

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

[diff] [blame]

610

],

611

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

612

{

613

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

614

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

615

},

616

],

617

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

618

{

619

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

620

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

621

},

622

],

623

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

624

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

625

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

Bu Sun Kim

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

[diff] [blame]

626

},

Sai Cheemalapati

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

[diff] [blame]

627

},

Yoshi Automation Bot

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

[diff] [blame]

628

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

629

#

Yoshi Automation Bot

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

[diff] [blame]

630

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

Bu Sun Kim

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

[diff] [blame]

631

#

Yoshi Automation Bot

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

[diff] [blame]

632

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

633

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

634

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

Bu Sun Kim

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

[diff] [blame]

635

"A String",

636

],

637

},

Sai Cheemalapati

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

[diff] [blame]

638

],

Yoshi Automation Bot

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

[diff] [blame]

639

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

640

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

641

},

642

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

643

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

644

#

645

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

646

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

647

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

648

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

649

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

650

},

651

],

652

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

653

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

654

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

655

#

656

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

657

#

658

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

659

#

660

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

661

#

662

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

663

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

664

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

665

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

666

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

667

#

668

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

669

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

670

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

671

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

672

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

673

},

674

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

675

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

676

#

677

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

678

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

679

"a_key": "A String",

680

},

681

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

682

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

683

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

684

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

685

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

686

#

687

#

688

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

689

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

690

#

691

#

692

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

693

#

694

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

695

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

696

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

697

#

698

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

699

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

700

{

701

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

702

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

703

},

704

],

705

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

706

},

707

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

708

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

709

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

710

{ # A network interface resource attached to an instance.

711

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

712

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

713

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

714

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

715

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

716

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

717

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

718

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

719

#

720

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

721

#

722

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

723

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

724

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

725

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

726

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

727

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

728

},

729

],

730

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

731

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

732

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

733

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

734

},

735

],

yoshi-code-bot

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

[diff] [blame]

736

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

737

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

738

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

739

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

740

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

741

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

742

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

743

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

744

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

745

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

746

#

747

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

748

#

749

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

750

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

751

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

752

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

753

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

754

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

755

},

756

],

yoshi-code-bot

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

[diff] [blame]

757

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

758

#

759

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

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

[diff] [blame]

760

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

761

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

762

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

763

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

764

#

765

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

766

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

767

# - projects/project/global/networks/network

768

# - global/networks/default

769

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

770

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

771

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

772

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

773

#

774

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

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

[diff] [blame]

775

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

776

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

777

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

778

"ipAllocationMode": "A String",

yoshi-code-bot

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

[diff] [blame]

779

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

780

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

781

# - regions/region/subnetworks/subnetwork

782

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

783

},

784

],

Yoshi Automation Bot

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

[diff] [blame]

785

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

786

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

787

# - regions/region/subnetworks/subnetwork

788

},

789

],

yoshi-code-bot

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

[diff] [blame]

790

"networkPerformanceConfig": {

791

"externalIpEgressBandwidthTier": "A String",

792

"totalEgressBandwidthTier": "A String",

793

},

Yoshi Automation Bot

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

[diff] [blame]

794

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

795

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

796

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

797

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

798

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

799

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

800

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

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

805

"A String",

806

],

yoshi-code-bot

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

[diff] [blame]

807

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

808

"scheduling": {

809

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

810

},

811

},

Yoshi Automation Bot

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

[diff] [blame]

812

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

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

813

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

Yoshi Automation Bot

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

[diff] [blame]

814

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

815

#

816

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

817

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

818

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Yoshi Automation Bot

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

[diff] [blame]

819

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

820

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

821

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

822

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

823

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

824

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

825

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

826

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

827

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

828

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

834

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

835

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

836

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

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

[diff] [blame]

837

"A String",

838

],

839

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

840

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

841

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

842

#

843

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

844

{ # A service account.

845

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

846

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

"A String",

],

},

],

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

852

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

853

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

854

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

855

},

856

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

857

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

858

},

859

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

860

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

861

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

862

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

863

},

864

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

865

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

866

},

867

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

yoshi-code-bot

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

[diff] [blame]

868

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

869

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

870

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

871

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

872

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

873

#

874

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

875

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

876

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

877

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

878

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

879

},

880

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

881

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

882

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

883

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

884

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

885

#

886

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

887

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

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

892

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

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

[diff] [blame]

893

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

894

"earliest": "A String",

895

"latest": "A String",

896

},

Yoshi Automation Bot

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

[diff] [blame]

897

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

898

"type": "A String", # Defines the type of maintenance.

899

},

900

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

901

},

902

],

Yoshi Automation Bot

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

[diff] [blame]

903

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

904

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

905

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

906

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

907

{

908

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

909

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

910

},

911

],

912

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

913

},

Bu Sun Kim

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

[diff] [blame]

914

},

Yoshi Automation Bot

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

[diff] [blame]

915

},

916

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

917

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

918

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

919

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

920

"A String",

921

],

922

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

923

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

924

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

925

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

926

{

927

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

928

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

929

},

930

],

931

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

932

},

933

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

938

<pre>Retrieves the next page of results.

939

940

Args:

941

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

942

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

943

944

Returns:

Bu Sun Kim

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

[diff] [blame]

945

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

Sai Cheemalapati

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

[diff] [blame]

946

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]

951

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

952

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

953

954

Args:

955

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

956

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

957

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

Dan O'Meara

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

[diff] [blame]

958

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

959

The object takes the form of:

960

961

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

962

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

963

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

964

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

965

#

966

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

967

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

Sai Cheemalapati

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

[diff] [blame]

968

#

969

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

970

#

971

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

972

#

973

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

974

#

975

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

976

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

977

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

978

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

979

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

980

#

981

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

982

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

983

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

984

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

Bu Sun Kim

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

[diff] [blame]

985

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

986

},

Bu Sun Kim

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

[diff] [blame]

987

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

Bu Sun Kim

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

[diff] [blame]

988

"forceAttach": True or False, # [Input Only] 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

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

[diff] [blame]

989

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

990

{ # Guest OS features.

991

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

992

},

993

],

994

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

995

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

996

#

997

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

998

#

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

#

Bu Sun Kim

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

[diff] [blame]

1006

#

Sai Cheemalapati

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

[diff] [blame]

1007

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

1008

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

1009

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

1010

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

1011

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

1012

#

1013

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

1014

{ # Guest OS features.

Bu Sun Kim

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

[diff] [blame]

1015

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

1016

},

1017

],

Bu Sun Kim

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

[diff] [blame]

1018

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

1019

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1020

},

Bu Sun Kim

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

[diff] [blame]

1021

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

1022

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

Dmitry Frenkel

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

[diff] [blame]

1023

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

1024

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1025

"A String",

1026

],

1027

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

1028

"A String",

1029

],

1030

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

1031

#

Bu Sun Kim

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

[diff] [blame]

1032

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

1033

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

Sai Cheemalapati

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

[diff] [blame]

1034

#

Sai Cheemalapati

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

[diff] [blame]

1035

#

1036

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

Bu Sun Kim

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

[diff] [blame]

1037

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

Sai Cheemalapati

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

[diff] [blame]

1038

#

Sai Cheemalapati

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

[diff] [blame]

1039

#

Bu Sun Kim

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

[diff] [blame]

1040

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

1041

# global/images/my-custom-image

Sai Cheemalapati

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

[diff] [blame]

1042

#

Sai Cheemalapati

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

[diff] [blame]

1043

#

Bu Sun Kim

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

[diff] [blame]

1044

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

1045

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

Sai Cheemalapati

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

[diff] [blame]

1046

#

Jon Wayne Parrott

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

[diff] [blame]

1047

#

1048

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

Dmitry Frenkel

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

[diff] [blame]

1049

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

1050

#

1051

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

1052

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

1053

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

1054

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

1055

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

1056

#

1057

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

1058

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

1059

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

1060

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

1061

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

1062

},

1063

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

1064

#

1065

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

1066

# global/snapshots/my-backup

1067

#

1068

#

1069

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

Dmitry Frenkel

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

[diff] [blame]

1070

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

Bu Sun Kim

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

[diff] [blame]

1071

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

1072

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

1073

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

1074

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

1075

#

1076

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

1077

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

1078

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

1079

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

1080

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

1081

},

1082

},

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

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

1085

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

1086

"A String",

1087

],

1088

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

1089

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1090

"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

1091

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

1092

{

1093

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

1094

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

1095

},

1096

],

1097

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

1098

{

1099

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

1100

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

1101

},

1102

],

1103

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

1104

{

1105

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

1106

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

1107

},

1108

],

1109

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

1110

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

1111

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

Bu Sun Kim

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

[diff] [blame]

1112

},

Bu Sun Kim

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

[diff] [blame]

1113

},

1114

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

1115

#

1116

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

1117

#

1118

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

1119

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

Bu Sun Kim

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

[diff] [blame]

1120

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

1121

"A String",

1122

],

Sai Cheemalapati

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

[diff] [blame]

1123

}

1124

Dmitry Frenkel

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

[diff] [blame]

1125

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]

1126

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.

1127

1128

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.

1129

1130

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]

1131

1132

Returns:

1133

An object of the form:

1134

Bu Sun Kim

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

[diff] [blame]

1135

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame]

1136

#

1137

# Google Compute Engine has three Operation resources:

1138

#

1139

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

1140

#

1141

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

1142

#

1143

# Operations can be global, regional or zonal.

1144

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

1145

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

1146

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

1147

#

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

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

Bu Sun Kim

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

[diff] [blame]

1155

{

Yoshi Automation Bot

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

[diff] [blame]

1156

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

1157

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

1158

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

Bu Sun Kim

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

[diff] [blame]

1159

},

1160

],

Yoshi Automation Bot

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

[diff] [blame]

1161

},

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

yoshi-code-bot

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

[diff] [blame]

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

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

1178

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

1179

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

1180

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

1181

{

1182

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

1183

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

1184

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

1185

{

1186

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

1187

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

1188

},

1189

],

1190

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

1191

},

1192

],

1193

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

1194

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

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

1199

<pre>Creates multiple instances. Count specifies the number of instances to create.

1200

1201

Args:

1202

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

1203

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

1204

body: object, The request body.

1205

The object takes the form of:

1206

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1207

{ # A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert and compute.regionInstances.recommendLocations. This resource is not persisted anywhere, it is used only for processing the requests.

Yoshi Automation Bot

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

[diff] [blame]

1208

"count": "A String", # The maximum number of instances to create.

Anthonios Partheniou

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

[diff] [blame]

1209

"instance": { # Represents an Instance resource. # DEPRECATED: Please use instance_properties instead.

Bu Sun Kim

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

[diff] [blame]

1210

#

Dan O'Meara

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

[diff] [blame]

1211

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

Dmitry Frenkel

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

[diff] [blame]

1212

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

1213

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

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1214

"numaNodeCount": 42, # The number of vNUMA nodes.

Dmitry Frenkel

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

[diff] [blame]

1215

"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-31 13:33:30 -0700

[diff] [blame]

1216

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

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

[diff] [blame]

1217

},

Bu Sun Kim

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

[diff] [blame]

1218

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

1219

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

1220

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

Bu Sun Kim

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

[diff] [blame]

1221

},

Bu Sun Kim

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

[diff] [blame]

1222

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

1223

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

1224

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

1225

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

1226

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

1227

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1228

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

1229

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

1230

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

1231

#

1232

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

1233

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

Sai Cheemalapati

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

[diff] [blame]

1234

#

1235

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

1236

#

1237

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

1238

#

1239

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

1240

#

1241

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

1242

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

1243

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

1244

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

1245

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

1246

#

1247

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

1248

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

1249

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

1250

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

Bu Sun Kim

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

[diff] [blame]

1251

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

1252

},

Bu Sun Kim

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

[diff] [blame]

1253

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

Bu Sun Kim

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

[diff] [blame]

1254

"forceAttach": True or False, # [Input Only] 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

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

[diff] [blame]

1255

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

1256

{ # Guest OS features.

1257

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

1258

},

1259

],

1260

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

1261

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

1262

#

1263

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

1264

#

1265

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

1266

"description": "A String", # An optional description. Provide this property when creating the disk.

1267

"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.

1268

"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.

1269

"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]

1270

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1271

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1272

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1273

# 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:

1274

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1275

# - projects/project/zones/zone/diskTypes/diskType

1276

# - 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]

1277

"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]

1278

#

1279

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1280

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1281

"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]

1282

},

1283

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1284

"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.

1285

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1286

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1287

"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]

1288

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1289

"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]

1290

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1291

"A String",

1292

],

1293

"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.

1294

"A String",

1295

],

1296

"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]

1297

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1298

# 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:

1299

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1300

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1301

#

1302

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1303

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1304

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1305

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1306

# To create a disk with a custom image that you created, specify the image name in the following format:

1307

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1308

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1309

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1310

# 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:

1311

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1312

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1313

#

1314

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1315

"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]

1316

#

1317

# 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.

1318

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1319

"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.

1320

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1321

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1322

#

1323

# The key must meet the following requirements before you can provide it to Compute Engine:

1324

# - The key is wrapped using a RSA public key certificate provided by Google.

1325

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1326

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1327

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1328

},

1329

"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.

1330

#

1331

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1332

# global/snapshots/my-backup

1333

#

1334

#

1335

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1336

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1337

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1338

"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.

1339

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1340

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1341

#

1342

# The key must meet the following requirements before you can provide it to Compute Engine:

1343

# - The key is wrapped using a RSA public key certificate provided by Google.

1344

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1345

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1346

"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]

1347

},

1348

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1349

"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.

1350

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1351

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1352

"A String",

1353

],

1354

"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.

1355

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1356

"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

1357

"dbs": [ # The Key Database (db).

1358

{

1359

"content": "A String", # The raw content in the secure keys file.

1360

"fileType": "A String", # The file type of source file.

1361

},

1362

],

1363

"dbxs": [ # The forbidden key database (dbx).

1364

{

1365

"content": "A String", # The raw content in the secure keys file.

1366

"fileType": "A String", # The file type of source file.

1367

},

1368

],

1369

"keks": [ # The Key Exchange Key (KEK).

1370

{

1371

"content": "A String", # The raw content in the secure keys file.

1372

"fileType": "A String", # The file type of source file.

1373

},

1374

],

1375

"pk": { # The Platform Key (PK).

1376

"content": "A String", # The raw content in the secure keys file.

1377

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1378

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1379

},

1380

"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]

1381

#

1382

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1383

#

1384

# 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]

1385

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1386

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

1387

"A String",

1388

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1389

},

1390

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1391

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1392

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1393

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1394

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

1395

"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.

1396

#

1397

# To see the latest fingerprint, make get() request to the instance.

1398

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1399

{ # A specification of the type and number of accelerator cards attached to the instance.

1400

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1401

"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.

1402

},

1403

],

1404

"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.

1405

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1406

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1407

#

1408

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

1409

#

1410

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

1411

#

1412

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

1413

#

1414

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

1415

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1416

"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.

1417

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1418

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1419

#

1420

# The key must meet the following requirements before you can provide it to Compute Engine:

1421

# - The key is wrapped using a RSA public key certificate provided by Google.

1422

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1423

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1424

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1425

},

1426

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

1427

"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.

1428

#

1429

# To see the latest fingerprint, make get() request to the instance.

1430

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1431

"a_key": "A String",

1432

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1433

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1434

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1435

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1436

"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:

1437

# zones/us-central1-f/machineTypes/n1-standard-1

1438

#

1439

#

1440

# 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):

1441

# zones/zone/machineTypes/custom-CPUS-MEMORY

1442

#

1443

#

1444

# For example: zones/us-central1-f/machineTypes/custom-4-5120

1445

#

1446

# For a full list of restrictions, read the Specifications for custom machine types.

1447

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

1448

"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.

1449

#

1450

# To see the latest fingerprint, make a get() request to retrieve the resource.

1451

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1452

{

1453

"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.

1454

"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).

1455

},

1456

],

1457

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1458

},

1459

"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".

1460

"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.

1461

"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.

1462

{ # A network interface resource attached to an instance.

1463

"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.

1464

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1465

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1466

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1467

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1468

"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.

1469

"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.

1470

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1471

#

1472

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1473

#

1474

# 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.

1475

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1476

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1477

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1478

"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.

1479

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1480

},

1481

],

1482

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1483

{ # An alias IP range attached to an instance's network interface.

1484

"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).

1485

"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.

1486

},

1487

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1488

"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-11-16 11:05:03 -0700

[diff] [blame]

1489

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1490

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

1491

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1492

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1493

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1494

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1495

"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.

1496

"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.

1497

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1498

#

1499

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1500

#

1501

# 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.

1502

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1503

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1504

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1505

"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.

1506

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1507

},

1508

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1509

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

1510

#

1511

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1512

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1513

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1514

"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.

1515

"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.

1516

#

1517

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1518

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1519

# - projects/project/global/networks/network

1520

# - global/networks/default

1521

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1522

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1523

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

1524

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

1525

#

1526

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1527

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1528

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1529

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

1530

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1531

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1532

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1533

# - regions/region/subnetworks/subnetwork

1534

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1535

},

1536

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1537

"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:

1538

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1539

# - regions/region/subnetworks/subnetwork

1540

},

1541

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1542

"networkPerformanceConfig": {

1543

"externalIpEgressBandwidthTier": "A String",

1544

"totalEgressBandwidthTier": "A String",

1545

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1546

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1547

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

1548

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1549

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

1550

"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.

1551

"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.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1552

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

1557

"A String",

1558

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1559

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

1560

"scheduling": {

1561

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

1562

},

1563

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1564

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1565

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1566

"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.

1567

#

1568

# 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]

1569

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1570

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1571

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1572

"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]

1573

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

1574

"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]

1575

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1576

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1577

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1578

"key": "A String", # Corresponds to the label key of Node resource.

1579

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1580

"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]

1586

"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]

1587

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1588

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1589

"A String",

1590

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1591

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1592

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1593

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

1594

#

1595

# 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.

1596

{ # A service account.

1597

"email": "A String", # Email address of the service account.

1598

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1604

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1605

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1606

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1607

},

1608

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1609

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1610

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1611

"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]

1612

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1613

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1614

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1615

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1616

"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]

1617

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1618

},

1619

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1620

"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]

1621

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1622

"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.

1623

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1624

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1625

#

1626

# The key must meet the following requirements before you can provide it to Compute Engine:

1627

# - The key is wrapped using a RSA public key certificate provided by Google.

1628

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1629

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1630

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1631

},

1632

"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]

1633

"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]

1634

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1635

"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.

1636

"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.

1637

#

1638

# To see the latest fingerprint, make get() request to the instance.

1639

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1644

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1645

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

1646

"earliest": "A String",

1647

"latest": "A String",

1648

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1649

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1650

"type": "A String", # Defines the type of maintenance.

1651

},

1652

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1653

},

1654

"instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

1655

"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.

1656

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1657

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1658

"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-31 13:33:30 -0700

[diff] [blame]

1659

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1660

},

1661

"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.

1662

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

1663

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1664

},

1665

"description": "A String", # An optional text description for the instances that are created from these properties.

1666

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1667

{ # An instance-attached disk resource.

1668

"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).

1669

"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.

1670

"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.

1671

#

1672

# 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.

1673

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

1674

#

1675

# 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.

1676

#

1677

# 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.

1678

#

1679

# 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.

1680

#

1681

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

1682

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1683

"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.

1684

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1685

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1686

#

1687

# The key must meet the following requirements before you can provide it to Compute Engine:

1688

# - The key is wrapped using a RSA public key certificate provided by Google.

1689

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1690

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1691

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1692

},

1693

"diskSizeGb": "A String", # The size of the disk in GB.

1694

"forceAttach": True or False, # [Input Only] 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.

1695

"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.

1696

{ # Guest OS features.

1697

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1698

},

1699

],

1700

"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.

1701

"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.

1702

#

1703

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1704

#

1705

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

1706

"description": "A String", # An optional description. Provide this property when creating the disk.

1707

"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.

1708

"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.

1709

"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:

1710

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

1711

#

1712

#

1713

# 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:

1714

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

1715

# - projects/project/zones/zone/diskTypes/diskType

1716

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

1717

"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.

1718

#

1719

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

1720

{ # Guest OS features.

1721

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

1722

},

1723

],

1724

"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.

1725

"a_key": "A String",

1726

},

1727

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1728

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

1729

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

1730

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1731

"A String",

1732

],

1733

"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.

1734

"A String",

1735

],

1736

"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.

1737

#

1738

# 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:

1739

# projects/debian-cloud/global/images/family/debian-9

1740

#

1741

#

1742

# Alternatively, use a specific version of a public operating system image:

1743

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

1744

#

1745

#

1746

# To create a disk with a custom image that you created, specify the image name in the following format:

1747

# global/images/my-custom-image

1748

#

1749

#

1750

# 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:

1751

# global/images/family/my-image-family

1752

#

1753

#

1754

# If the source image is deleted later, this field will not be set.

1755

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

1756

#

1757

# 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.

1758

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1759

"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.

1760

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1761

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1762

#

1763

# The key must meet the following requirements before you can provide it to Compute Engine:

1764

# - The key is wrapped using a RSA public key certificate provided by Google.

1765

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1766

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1767

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1768

},

1769

"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.

1770

#

1771

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

1772

# global/snapshots/my-backup

1773

#

1774

#

1775

# If the source snapshot is deleted later, this field will not be set.

1776

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1777

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1778

"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.

1779

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1780

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

1781

#

1782

# The key must meet the following requirements before you can provide it to Compute Engine:

1783

# - The key is wrapped using a RSA public key certificate provided by Google.

1784

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

1785

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

1786

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1787

},

1788

},

1789

"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.

1790

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1791

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1792

"A String",

1793

],

1794

"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.

1795

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1796

"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

1797

"dbs": [ # The Key Database (db).

1798

{

1799

"content": "A String", # The raw content in the secure keys file.

1800

"fileType": "A String", # The file type of source file.

1801

},

1802

],

1803

"dbxs": [ # The forbidden key database (dbx).

1804

{

1805

"content": "A String", # The raw content in the secure keys file.

1806

"fileType": "A String", # The file type of source file.

1807

},

1808

],

1809

"keks": [ # The Key Exchange Key (KEK).

1810

{

1811

"content": "A String", # The raw content in the secure keys file.

1812

"fileType": "A String", # The file type of source file.

1813

},

1814

],

1815

"pk": { # The Platform Key (PK).

1816

"content": "A String", # The raw content in the secure keys file.

1817

"fileType": "A String", # The file type of source file.

1818

},

1819

},

1820

"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.

1821

#

1822

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

1823

#

1824

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

1825

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

1826

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

"A String",

],

},

],

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

1832

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1833

},

1834

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1835

{ # A specification of the type and number of accelerator cards attached to the instance.

1836

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1837

"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.

1838

},

1839

],

1840

"labels": { # Labels to apply to instances that are created from these properties.

1841

"a_key": "A String",

1842

},

1843

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1844

"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.

1845

"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.

1846

#

1847

# To see the latest fingerprint, make a get() request to retrieve the resource.

1848

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

1849

{

1850

"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.

1851

"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).

1852

},

1853

],

1854

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1855

},

1856

"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.

1857

"networkInterfaces": [ # An array of network access configurations for this interface.

1858

{ # A network interface resource attached to an instance.

1859

"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.

1860

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1861

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1862

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1863

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1864

"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.

1865

"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.

1866

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1867

#

1868

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1869

#

1870

# 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.

1871

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1872

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1873

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1874

"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.

1875

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1876

},

1877

],

1878

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1879

{ # An alias IP range attached to an instance's network interface.

1880

"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).

1881

"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.

1882

},

1883

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1884

"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]

1885

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1886

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

1887

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1888

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

1889

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1890

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1891

"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.

1892

"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.

1893

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

1894

#

1895

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

1896

#

1897

# 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.

1898

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

1899

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1900

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

1901

"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.

1902

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1903

},

1904

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1905

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

1906

#

1907

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1908

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1909

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1910

"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.

1911

"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.

1912

#

1913

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

1914

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

1915

# - projects/project/global/networks/network

1916

# - global/networks/default

1917

"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.

1918

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1919

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

1920

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

1921

#

1922

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1923

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1924

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1925

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

1926

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1927

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

1928

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1929

# - regions/region/subnetworks/subnetwork

1930

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1931

},

1932

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1933

"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:

1934

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

1935

# - regions/region/subnetworks/subnetwork

1936

},

1937

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1938

"networkPerformanceConfig": {

1939

"externalIpEgressBandwidthTier": "A String",

1940

"totalEgressBandwidthTier": "A String",

1941

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1942

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

1943

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1944

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that instances can consume from.

1945

"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.

1946

"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.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1947

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

1952

"A String",

1953

],

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1954

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1955

"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.

1956

#

1957

# 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]

1958

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1959

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1960

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1961

"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]

1962

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

1963

"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]

1964

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1965

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1966

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1967

"key": "A String", # Corresponds to the label key of Node resource.

1968

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1969

"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.

1975

"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.

1976

},

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

1977

"secureTags": [ # [Input Only] Secure tags to apply to this instance. Maximum number of secure tags allowed is 50.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1978

"A String",

1979

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1980

"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.

1981

{ # A service account.

1982

"email": "A String", # Email address of the service account.

1983

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1989

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1990

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1991

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1992

},

1993

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1994

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1995

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1996

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1997

},

1998

"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.

1999

"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.

2000

#

2001

# To see the latest fingerprint, make get() request to the instance.

2002

"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]

2007

"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.

2008

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2009

"a_key": {

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2010

"preference": "A String", # Preference for a given location: ALLOW or DENY.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2011

},

2012

},

2013

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2014

"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.

2015

"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]

2016

"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.

2017

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

2018

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

2019

},

2020

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2021

"predefinedNames": [ # DEPRECATED: Please use per_instance_properties instead.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2022

"A String",

2023

],

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

2024

"secureTags": [ # DEPRECATED: Please use instance_properties.secure_tag instead. Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

2025

"A String",

2026

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2027

"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.

2028

#

2029

# It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

2030

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

2031

# - projects/project/global/instanceTemplates/instanceTemplate

2032

# - global/instanceTemplates/instanceTemplate

2033

#

2034

# This field is optional.

2035

}

2036

2037

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.

2038

2039

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.

2040

2041

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2042

2043

Returns:

2044

An object of the form:

2045

2046

{ # Represents an Operation resource.

2047

#

2048

# Google Compute Engine has three Operation resources:

2049

#

2050

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2051

#

2052

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2053

#

2054

# Operations can be global, regional or zonal.

2055

# - For global operations, use the `globalOperations` resource.

2056

# - For regional operations, use the `regionOperations` resource.

2057

# - For zonal operations, use the `zonalOperations` resource.

2058

#

2059

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2060

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2061

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2062

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2063

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2064

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2065

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2066

{

2067

"code": "A String", # [Output Only] The error type identifier for this error.

2068

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2069

"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`.

2074

"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.

2075

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2076

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2077

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2078

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2079

"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]

2080

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2081

"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.

2082

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2083

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2084

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2085

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2086

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2087

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2088

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2089

"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.

2090

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2091

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2092

{

2093

"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.

2094

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2095

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2096

{

2097

"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).

2098

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2099

},

2100

],

2101

"message": "A String", # [Output Only] A human-readable description of the warning code.

2102

},

2103

],

2104

"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="close">close()</code>

2110

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="delete">delete(project, zone, instance, requestId=None)</code>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2115

<pre>Deletes the specified Instance resource. For more information, see Deleting an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2116

2117

Args:

2118

project: string, Project ID for this request. (required)

2119

zone: string, The name of the zone for this request. (required)

2120

instance: string, Name of the instance resource to delete. (required)

2121

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.

2122

2123

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.

2124

2125

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2126

2127

Returns:

2128

An object of the form:

2129

2130

{ # Represents an Operation resource.

2131

#

2132

# Google Compute Engine has three Operation resources:

2133

#

2134

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2135

#

2136

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2137

#

2138

# Operations can be global, regional or zonal.

2139

# - For global operations, use the `globalOperations` resource.

2140

# - For regional operations, use the `regionOperations` resource.

2141

# - For zonal operations, use the `zonalOperations` resource.

2142

#

2143

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2144

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2145

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2146

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2147

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2148

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2149

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2150

{

2151

"code": "A String", # [Output Only] The error type identifier for this error.

2152

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2153

"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`.

2158

"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.

2159

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2160

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2161

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2162

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2163

"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]

2164

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2165

"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.

2166

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2167

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2168

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2169

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2170

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2171

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2172

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2173

"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.

2174

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2175

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2176

{

2177

"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.

2178

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2179

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2180

{

2181

"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).

2182

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2183

},

2184

],

2185

"message": "A String", # [Output Only] A human-readable description of the warning code.

2186

},

2187

],

2188

"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="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None)</code>

2194

<pre>Deletes an access config from an instance's network interface.

2195

2196

Args:

2197

project: string, Project ID for this request. (required)

2198

zone: string, The name of the zone for this request. (required)

2199

instance: string, The instance name for this request. (required)

2200

accessConfig: string, The name of the access config to delete. (required)

2201

networkInterface: string, The name of the network interface. (required)

2202

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.

2203

2204

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.

2205

2206

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2207

2208

Returns:

2209

An object of the form:

2210

2211

{ # Represents an Operation resource.

2212

#

2213

# Google Compute Engine has three Operation resources:

2214

#

2215

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2216

#

2217

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2218

#

2219

# Operations can be global, regional or zonal.

2220

# - For global operations, use the `globalOperations` resource.

2221

# - For regional operations, use the `regionOperations` resource.

2222

# - For zonal operations, use the `zonalOperations` resource.

2223

#

2224

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2225

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2226

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2227

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2228

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2229

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2230

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2231

{

2232

"code": "A String", # [Output Only] The error type identifier for this error.

2233

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2234

"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`.

2239

"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.

2240

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2241

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2242

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2243

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2244

"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]

2245

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2246

"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.

2247

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2248

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2249

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2250

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2251

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2252

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2253

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2254

"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.

2255

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2256

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2257

{

2258

"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.

2259

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2260

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2261

{

2262

"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).

2263

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2264

},

2265

],

2266

"message": "A String", # [Output Only] A human-readable description of the warning code.

2267

},

2268

],

2269

"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="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None)</code>

2275

<pre>Detaches a disk from an instance.

2276

2277

Args:

2278

project: string, Project ID for this request. (required)

2279

zone: string, The name of the zone for this request. (required)

2280

instance: string, Instance name for this request. (required)

2281

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)

2282

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.

2283

2284

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.

2285

2286

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

2287

2288

Returns:

2289

An object of the form:

2290

2291

{ # Represents an Operation resource.

2292

#

2293

# Google Compute Engine has three Operation resources:

2294

#

2295

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2296

#

2297

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2298

#

2299

# Operations can be global, regional or zonal.

2300

# - For global operations, use the `globalOperations` resource.

2301

# - For regional operations, use the `regionOperations` resource.

2302

# - For zonal operations, use the `zonalOperations` resource.

2303

#

2304

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

2305

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2306

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2307

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2308

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2309

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2310

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

2311

{

2312

"code": "A String", # [Output Only] The error type identifier for this error.

2313

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2314

"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`.

2319

"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.

2320

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2321

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2322

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2323

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2324

"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]

2325

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2326

"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.

2327

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2328

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2329

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2330

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2331

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2332

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2333

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2334

"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.

2335

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2336

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2337

{

2338

"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.

2339

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2340

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2341

{

2342

"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).

2343

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2344

},

2345

],

2346

"message": "A String", # [Output Only] A human-readable description of the warning code.

2347

},

2348

],

2349

"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="get">get(project, zone, instance)</code>

2355

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

2356

2357

Args:

2358

project: string, Project ID for this request. (required)

2359

zone: string, The name of the zone for this request. (required)

2360

instance: string, Name of the instance resource to return. (required)

2361

2362

Returns:

2363

An object of the form:

2364

2365

{ # Represents an Instance resource.

2366

#

2367

# 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 ==)

2368

"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.

2369

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

2370

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2371

"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-31 13:33:30 -0700

[diff] [blame]

2372

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2373

},

2374

"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.

2375

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2376

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2377

},

2378

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2379

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2380

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2381

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2382

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

2383

{ # An instance-attached disk resource.

2384

"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).

2385

"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.

2386

"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.

2387

#

2388

# 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.

2389

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

2390

#

2391

# 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.

2392

#

2393

# 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.

2394

#

2395

# 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.

2396

#

2397

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

2398

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2399

"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.

2400

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2401

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2402

#

2403

# The key must meet the following requirements before you can provide it to Compute Engine:

2404

# - The key is wrapped using a RSA public key certificate provided by Google.

2405

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2406

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2407

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2408

},

2409

"diskSizeGb": "A String", # The size of the disk in GB.

2410

"forceAttach": True or False, # [Input Only] 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.

2411

"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.

2412

{ # Guest OS features.

2413

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2414

},

2415

],

2416

"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.

2417

"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.

2418

#

2419

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2420

#

2421

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

2422

"description": "A String", # An optional description. Provide this property when creating the disk.

2423

"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.

2424

"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.

2425

"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:

2426

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

2427

#

2428

#

2429

# 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:

2430

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

2431

# - projects/project/zones/zone/diskTypes/diskType

2432

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

2433

"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.

2434

#

2435

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

2436

{ # Guest OS features.

2437

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

2438

},

2439

],

2440

"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.

2441

"a_key": "A String",

2442

},

2443

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

2444

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

2445

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

2446

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

2447

"A String",

2448

],

2449

"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.

2450

"A String",

2451

],

2452

"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.

2453

#

2454

# 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:

2455

# projects/debian-cloud/global/images/family/debian-9

2456

#

2457

#

2458

# Alternatively, use a specific version of a public operating system image:

2459

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

2460

#

2461

#

2462

# To create a disk with a custom image that you created, specify the image name in the following format:

2463

# global/images/my-custom-image

2464

#

2465

#

2466

# 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:

2467

# global/images/family/my-image-family

2468

#

2469

#

2470

# If the source image is deleted later, this field will not be set.

2471

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

2472

#

2473

# 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.

2474

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2475

"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.

2476

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2477

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2478

#

2479

# The key must meet the following requirements before you can provide it to Compute Engine:

2480

# - The key is wrapped using a RSA public key certificate provided by Google.

2481

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2482

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2483

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2484

},

2485

"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.

2486

#

2487

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

2488

# global/snapshots/my-backup

2489

#

2490

#

2491

# If the source snapshot is deleted later, this field will not be set.

2492

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

2493

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2494

"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.

2495

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2496

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2497

#

2498

# The key must meet the following requirements before you can provide it to Compute Engine:

2499

# - The key is wrapped using a RSA public key certificate provided by Google.

2500

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2501

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2502

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2503

},

2504

},

2505

"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.

2506

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2507

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2508

"A String",

2509

],

2510

"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.

2511

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

2512

"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

2513

"dbs": [ # The Key Database (db).

2514

{

2515

"content": "A String", # The raw content in the secure keys file.

2516

"fileType": "A String", # The file type of source file.

2517

},

2518

],

2519

"dbxs": [ # The forbidden key database (dbx).

2520

{

2521

"content": "A String", # The raw content in the secure keys file.

2522

"fileType": "A String", # The file type of source file.

2523

},

2524

],

2525

"keks": [ # The Key Exchange Key (KEK).

2526

{

2527

"content": "A String", # The raw content in the secure keys file.

2528

"fileType": "A String", # The file type of source file.

2529

},

2530

],

2531

"pk": { # The Platform Key (PK).

2532

"content": "A String", # The raw content in the secure keys file.

2533

"fileType": "A String", # The file type of source file.

2534

},

2535

},

2536

"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.

2537

#

2538

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

2539

#

2540

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

2541

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

2542

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

"A String",

],

},

],

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2548

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2549

},

2550

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

2551

"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.

2552

#

2553

# To see the latest fingerprint, make get() request to the instance.

2554

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2555

{ # A specification of the type and number of accelerator cards attached to the instance.

2556

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2557

"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.

2558

},

2559

],

2560

"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.

2561

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2562

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

2563

#

2564

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

2565

#

2566

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

2567

#

2568

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

2569

#

2570

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

2571

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2572

"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.

2573

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2574

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2575

#

2576

# The key must meet the following requirements before you can provide it to Compute Engine:

2577

# - The key is wrapped using a RSA public key certificate provided by Google.

2578

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2579

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2580

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2581

},

2582

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

2583

"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.

2584

#

2585

# To see the latest fingerprint, make get() request to the instance.

2586

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2587

"a_key": "A String",

2588

},

2589

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2590

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2591

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

2592

"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:

2593

# zones/us-central1-f/machineTypes/n1-standard-1

2594

#

2595

#

2596

# 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):

2597

# zones/zone/machineTypes/custom-CPUS-MEMORY

2598

#

2599

#

2600

# For example: zones/us-central1-f/machineTypes/custom-4-5120

2601

#

2602

# For a full list of restrictions, read the Specifications for custom machine types.

2603

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

2604

"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.

2605

#

2606

# To see the latest fingerprint, make a get() request to retrieve the resource.

2607

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

2608

{

2609

"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.

2610

"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).

2611

},

2612

],

2613

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2614

},

2615

"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".

2616

"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.

2617

"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.

2618

{ # A network interface resource attached to an instance.

2619

"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.

2620

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2621

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

2622

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2623

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2624

"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.

2625

"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.

2626

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2627

#

2628

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2629

#

2630

# 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.

2631

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2632

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2633

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2634

"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.

2635

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2636

},

2637

],

2638

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2639

{ # An alias IP range attached to an instance's network interface.

2640

"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).

2641

"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.

2642

},

2643

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2644

"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]

2645

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

2646

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

2647

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2648

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

2649

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2650

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2651

"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.

2652

"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.

2653

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

2654

#

2655

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

2656

#

2657

# 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.

2658

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

2659

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2660

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

2661

"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.

2662

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2663

},

2664

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2665

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

2666

#

2667

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2668

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2669

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2670

"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.

2671

"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.

2672

#

2673

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

2674

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

2675

# - projects/project/global/networks/network

2676

# - global/networks/default

2677

"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.

2678

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

2679

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

2680

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

2681

#

2682

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2683

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

2684

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

2685

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

2686

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2687

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

2688

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2689

# - regions/region/subnetworks/subnetwork

2690

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

2691

},

2692

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2693

"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:

2694

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

2695

# - regions/region/subnetworks/subnetwork

2696

},

2697

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2698

"networkPerformanceConfig": {

2699

"externalIpEgressBandwidthTier": "A String",

2700

"totalEgressBandwidthTier": "A String",

2701

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2702

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

2703

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

2704

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

2705

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

2706

"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.

2707

"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.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

2708

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2713

"A String",

2714

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2715

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

2716

"scheduling": {

2717

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

2718

},

2719

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2720

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2721

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2722

"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.

2723

#

2724

# 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]

2725

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

2726

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2727

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

2728

"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]

2729

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2730

"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]

2731

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2732

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2733

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2734

"key": "A String", # Corresponds to the label key of Node resource.

2735

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2736

"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.

2742

"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.

2743

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2744

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2745

"A String",

2746

],

2747

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2748

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2749

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

2750

#

2751

# 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.

2752

{ # A service account.

2753

"email": "A String", # Email address of the service account.

2754

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2760

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2761

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2762

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2763

},

2764

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2765

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2766

},

2767

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

2768

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2769

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2770

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2771

},

2772

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

2773

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2774

},

2775

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2776

"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]

2777

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2778

"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.

2779

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2780

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

2781

#

2782

# The key must meet the following requirements before you can provide it to Compute Engine:

2783

# - The key is wrapped using a RSA public key certificate provided by Google.

2784

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

2785

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

2786

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2787

},

2788

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

2789

"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.

2790

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2791

"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.

2792

"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.

2793

#

2794

# To see the latest fingerprint, make get() request to the instance.

2795

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

2800

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2801

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

2802

"earliest": "A String",

2803

"latest": "A String",

2804

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2805

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

2806

"type": "A String", # Defines the type of maintenance.

2807

},

2808

"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.

2809

}</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]

2813

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface)</code>

2814

<pre>Returns effective firewalls applied to an interface of the instance.

2815

2816

Args:

2817

project: string, Project ID for this request. (required)

2818

zone: string, The name of the zone for this request. (required)

2819

instance: string, Name of the instance scoping this request. (required)

2820

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

2821

2822

Returns:

2823

An object of the form:

2824

2825

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2826

"firewallPolicys": [ # Effective firewalls from firewall policies.

2827

{

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2828

"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]

2829

"name": "A String", # [Output Only] The name of the firewall policy.

2830

"rules": [ # The rules that apply to the network.

2831

{ # 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).

2832

"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]

2833

"description": "A String", # An optional description for this resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2834

"direction": "A String", # The direction in which this rule applies.

2835

"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.

2836

"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.

2837

"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]

2838

"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]

2839

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

2840

"A String",

2841

],

2842

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2843

{

2844

"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.

2845

"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.

2846

#

2847

# 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.

2853

"A String",

2854

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2855

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

2856

{

2857

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

2858

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

2859

},

2860

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2861

},

2862

"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.

2863

"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]

2864

"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]

2865

"A String",

2866

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2867

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

2868

{

2869

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

2870

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

2871

},

2872

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2873

"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]

2878

"shortName": "A String", # [Output Only] The short name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2879

"type": "A String", # [Output Only] The type of the firewall policy.

2880

},

2881

],

2882

"firewalls": [ # Effective firewalls on the instance.

2883

{ # Represents a Firewall Rule resource.

2884

#

2885

# Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

2886

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2887

{

2888

"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.

2889

"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.

2890

#

2891

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2897

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2898

{

2899

"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.

2900

"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.

2901

#

2902

# 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.

2908

"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.

2909

"A String",

2910

],

2911

"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.

2912

"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.

2913

"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.

2914

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2915

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

2916

"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.

2917

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2918

"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.

2919

},

2920

"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.

2921

"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:

2922

# global/networks/default

2923

# 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:

2924

# - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network

2925

# - projects/myproject/global/networks/my-network

2926

# - global/networks/default

2927

"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`.

2928

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2929

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2930

"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.

2931

"A String",

2932

],

2933

"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.

2934

"A String",

2935

],

2936

"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.

2937

"A String",

2938

],

2939

"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.

2940

"A String",

2941

],

2942

"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.

2948

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

2949

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2950

"rules": [ # The rules that apply to the network.

2951

{ # 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]

2952

"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]

2953

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2954

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

2955

"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.

2956

#

2957

# This field may only be specified when the versioned_expr is set to FIREWALL.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2958

"headerAction": { # Optional, additional actions that are performed on headers.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

2959

"requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2960

{

2961

"headerName": "A String", # The name of the header to set.

2962

"headerValue": "A String", # The value to set the named header to.

2963

},

2964

],

2965

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2966

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2967

"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.

2968

"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.

2969

"destIpRanges": [ # CIDR IP address range.

2970

#

2971

# 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]

2972

"A String",

2973

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2974

"destPorts": [ # Pairs of IP protocols and ports that the rule should match.

2975

#

2976

# 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]

2977

{

2978

"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.

2979

"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.

2980

#

2981

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2982

#

2983

# 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]

2988

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2989

#

2990

# This field may only be specified when versioned_expr is set to FIREWALL.

2991

{

2992

"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.

2993

"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.

2994

#

2995

# Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

2996

#

2997

# This field may only be specified when versioned_expr is set to FIREWALL.

2998

"A String",

2999

],

3000

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3001

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3002

"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]

3003

"A String",

3004

],

3005

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3006

"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]

3007

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3008

# Example (Comparison):

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3009

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3010

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3011

#

3012

# Example (Equality):

3013

#

3014

# 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'"

3019

#

3020

# Example (Data Manipulation):

3021

#

3022

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3023

#

3024

# 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.

3025

"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.

3026

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3027

"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.

3028

"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.

3029

},

3030

"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]

3031

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3032

"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]

3033

"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.

3034

"rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3035

"banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

3036

"banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3037

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

3038

"intervalSec": 42, # Interval over which the threshold is computed.

3039

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3040

"conformAction": "A String", # Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload".

3041

"enforceOnKey": "A String", # Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule.

3042

"exceedAction": "A String", # When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.

3043

"rateLimitThreshold": { # Threshold at which to begin ratelimiting.

3044

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

3045

"intervalSec": 42, # Interval over which the threshold is computed.

3046

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3047

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3048

"redirectTarget": "A String", # This must be specified for redirect actions. Cannot be specified for any other actions.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3049

"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.

3050

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

3051

"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.

3052

#

3053

# This field may only be specified when versioned_expr is set to FIREWALL.

3054

"A String",

3055

],

3056

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

3057

"A String",

3058

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3059

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

],

}</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]

3067

<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]

3068

<pre>Returns the specified guest attributes entry.

3069

3070

Args:

3071

project: string, Project ID for this request. (required)

3072

zone: string, The name of the zone for this request. (required)

3073

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3074

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3075

variableKey: string, Specifies the key for the guest attributes entry.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3076

3077

Returns:

3078

An object of the form:

3079

3080

{ # A guest attributes entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3081

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

3082

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

3083

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

3084

"items": [

3085

{ # A guest attributes namespace/key/value entry.

3086

"key": "A String", # Key for the guest attribute entry.

3087

"namespace": "A String", # Namespace for the guest attribute entry.

3088

"value": "A String", # Value for the guest attribute entry.

},

],

},

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3093

"variableKey": "A String", # The key to search for.

3094

"variableValue": "A String", # [Output Only] The value found for the requested key.

3095

}</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]

3099

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3100

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

3101

3102

Args:

3103

project: string, Project ID for this request. (required)

3104

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3105

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3106

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3107

3108

Returns:

3109

An object of the form:

3110

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3111

{ # 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.

3116

#

3117

# 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

3126

#

3127

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

3128

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

3129

{ # 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.

3130

#

3131

# 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.

3132

#

3133

# Example Policy with multiple AuditConfigs:

3134

#

3135

# { "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" ] } ] } ] }

3136

#

3137

# 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.

3138

"auditLogConfigs": [ # The configuration for logging of each type of permission.

3139

{ # Provides the configuration for logging a type of permissions. Example:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3140

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3141

# { "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]

3142

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3143

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3144

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

3145

"A String",

3146

],

3147

"ignoreChildExemptions": True or False,

3148

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3149

},

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.

3155

},

3156

],

3157

"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.

3158

{ # Associates `members` with a `role`.

3159

"bindingId": "A String",

3160

"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.

3161

#

3162

# If the condition evaluates to `true`, then this binding applies to the current request.

3163

#

3164

# 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.

3165

#

3166

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3167

#

3168

# Example (Comparison):

3169

#

3170

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

3171

#

3172

# Example (Equality):

3173

#

3174

# 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'"

3179

#

3180

# Example (Data Manipulation):

3181

#

3182

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

3183

#

3184

# 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.

3185

"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.

3186

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3187

"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.

3188

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3189

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3190

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

3191

#

3192

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

3193

#

3194

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

3195

#

3196

# * `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`.

3201

#

3202

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

3203

#

3204

# * `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.

3205

#

3206

# * `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.

3207

#

3208

# * `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`.

3213

"A String",

3214

],

3215

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3216

},

3217

],

3218

"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.

3219

#

3220

# **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.

3221

"iamOwned": True or False,

3222

"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.

3223

{ # A rule to be applied in a Policy.

3224

"action": "A String", # Required

3225

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

3226

{ # A condition to be met.

3227

"iam": "A String", # Trusted attributes supplied by the IAM system.

3228

"op": "A String", # An operator to apply the subject with.

3229

"svc": "A String", # Trusted attributes discharged by the service.

3230

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

3231

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

3237

"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.

3238

"A String",

3239

],

3240

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

3241

{ # Specifies what kind of log the caller must write

3242

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

3243

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

3244

"permissionType": "A String", # The type of the permission that was checked.

3245

},

3246

"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]

3247

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3248

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

3249

#

3250

# 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.

3251

#

3252

# Field names correspond to IAM request parameters and field values are their respective values.

3253

#

3254

# 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.

3255

#

3256

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

3257

"customFields": [ # Custom fields.

3258

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

3259

"name": "A String", # Name is the field name.

3260

"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]

3261

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3262

],

3263

"field": "A String", # The field value to attribute.

3264

"metric": "A String", # The metric to update.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3265

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3266

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

3267

"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.

3272

"A String",

3273

],

3274

"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.

3280

#

3281

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

3282

#

3283

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

3284

#

3285

# * 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

3286

#

3287

# **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.

3288

#

3289

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

3290

#

3291

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

3292

}</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]

3296

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance)</code>

3297

<pre>Returns the screenshot from the specified instance.

3298

3299

Args:

3300

project: string, Project ID for this request. (required)

3301

zone: string, The name of the zone for this request. (required)

3302

instance: string, Name of the instance scoping this request. (required)

3303

3304

Returns:

3305

An object of the form:

3306

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3307

{ # An instance's screenshot.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3308

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

3309

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

3310

}</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]

3314

<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]

3315

<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]

3316

3317

Args:

3318

project: string, Project ID for this request. (required)

3319

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3320

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3321

port: integer, Specifies which COM or serial port to retrieve data from.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3322

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`.

3323

3324

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.

3325

3326

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]

3327

3328

Returns:

3329

An object of the form:

3330

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

{ # An instance's serial console output.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3332

"contents": "A String", # [Output Only] The contents of the console output.

3333

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

3334

"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.

3335

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3336

"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.

3337

}</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]

3341

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance)</code>

3342

<pre>Returns the Shielded Instance Identity of an instance

3343

3344

Args:

3345

project: string, Project ID for this request. (required)

3346

zone: string, The name of the zone for this request. (required)

3347

instance: string, Name or id of the instance scoping this request. (required)

3348

3349

Returns:

3350

An object of the form:

3351

3352

{ # A shielded Instance identity entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3353

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3354

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3355

"ekPub": "A String", # A PEM-encoded public key.

3356

},

3357

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

3358

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

3359

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3360

"ekPub": "A String", # A PEM-encoded public key.

3361

},

3362

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance)</code>

3367

<pre>Returns the Shielded VM Identity of an instance

3368

3369

Args:

3370

project: string, Project ID for this request. (required)

3371

zone: string, The name of the zone for this request. (required)

3372

instance: string, Name of the instance scoping this request. (required)

3373

3374

Returns:

3375

An object of the form:

3376

3377

{ # A shielded VM identity entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3378

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

3379

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3380

"ekPub": "A String", # A PEM-encoded public key.

3381

},

3382

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

3383

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

3384

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

3385

"ekPub": "A String", # A PEM-encoded public key.

3386

},

3387

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

3391

<code class="details" id="insert">insert(project, zone, body=None, requestId=None, secureTags=None, sourceInstanceTemplate=None, sourceMachineImage=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3392

<pre>Creates an instance resource in the specified project using the data included in the request.

3393

3394

Args:

3395

project: string, Project ID for this request. (required)

3396

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3397

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3398

The object takes the form of:

3399

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3400

{ # Represents an Instance resource.

3401

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3402

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3403

"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.

3404

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

3405

"numaNodeCount": 42, # The number of vNUMA nodes.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3406

"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-31 13:33:30 -0700

[diff] [blame]

3407

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3408

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3409

"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.

3410

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3411

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3412

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3413

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3414

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3415

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3416

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3417

"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]

3418

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3419

"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).

3420

"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.

3421

"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.

3422

#

3423

# 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]

3424

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3425

#

3426

# 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.

3427

#

3428

# 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.

3429

#

3430

# 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.

3431

#

3432

# 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]

3433

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3434

"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.

3435

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3436

"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]

3437

#

3438

# The key must meet the following requirements before you can provide it to Compute Engine:

3439

# - 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]

3440

# - 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]

3441

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3442

"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]

3443

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3444

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3445

"forceAttach": True or False, # [Input Only] 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

2020-05-20 12:08:20 -0700

[diff] [blame]

3446

"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.

3447

{ # Guest OS features.

3448

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

3449

},

3450

],

3451

"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.

3452

"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]

3453

#

3454

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

3455

#

3456

# 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]

3457

"description": "A String", # An optional description. Provide this property when creating the disk.

3458

"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.

3459

"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.

3460

"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]

3461

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

3462

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3463

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3464

# 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:

3465

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

3466

# - projects/project/zones/zone/diskTypes/diskType

3467

# - 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]

3468

"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]

3469

#

3470

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

3471

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3472

"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]

3473

},

3474

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3475

"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.

3476

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3477

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3478

"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]

3479

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3480

"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]

3481

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3482

"A String",

3483

],

3484

"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.

3485

"A String",

3486

],

3487

"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]

3488

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3489

# 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:

3490

# projects/debian-cloud/global/images/family/debian-9

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3491

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3492

#

3493

# Alternatively, use a specific version of a public operating system image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3494

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3495

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3496

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3497

# To create a disk with a custom image that you created, specify the image name in the following format:

3498

# global/images/my-custom-image

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3499

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3500

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3501

# 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:

3502

# global/images/family/my-image-family

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3503

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3504

#

3505

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3506

"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]

3507

#

3508

# 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.

3509

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3510

"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.

3511

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3512

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3513

#

3514

# The key must meet the following requirements before you can provide it to Compute Engine:

3515

# - The key is wrapped using a RSA public key certificate provided by Google.

3516

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3517

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3518

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3519

},

3520

"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.

3521

#

3522

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

3523

# global/snapshots/my-backup

3524

#

3525

#

3526

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3527

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3528

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3529

"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.

3530

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3531

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3532

#

3533

# The key must meet the following requirements before you can provide it to Compute Engine:

3534

# - The key is wrapped using a RSA public key certificate provided by Google.

3535

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3536

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3537

"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]

3538

},

3539

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3540

"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.

3541

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3542

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3543

"A String",

3544

],

3545

"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.

3546

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

3547

"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

3548

"dbs": [ # The Key Database (db).

3549

{

3550

"content": "A String", # The raw content in the secure keys file.

3551

"fileType": "A String", # The file type of source file.

3552

},

3553

],

3554

"dbxs": [ # The forbidden key database (dbx).

3555

{

3556

"content": "A String", # The raw content in the secure keys file.

3557

"fileType": "A String", # The file type of source file.

3558

},

3559

],

3560

"keks": [ # The Key Exchange Key (KEK).

3561

{

3562

"content": "A String", # The raw content in the secure keys file.

3563

"fileType": "A String", # The file type of source file.

3564

},

3565

],

3566

"pk": { # The Platform Key (PK).

3567

"content": "A String", # The raw content in the secure keys file.

3568

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3569

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3570

},

3571

"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]

3572

#

3573

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

3574

#

3575

# 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]

3576

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3577

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

3578

"A String",

3579

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3580

},

3581

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3582

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3583

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3584

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3585

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

3586

"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.

3587

#

3588

# To see the latest fingerprint, make get() request to the instance.

3589

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3590

{ # A specification of the type and number of accelerator cards attached to the instance.

3591

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3592

"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.

3593

},

3594

],

3595

"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.

3596

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3597

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3598

#

3599

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

3600

#

3601

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

3602

#

3603

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

3604

#

3605

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

3606

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3607

"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.

3608

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3609

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3610

#

3611

# The key must meet the following requirements before you can provide it to Compute Engine:

3612

# - The key is wrapped using a RSA public key certificate provided by Google.

3613

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3614

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3615

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3616

},

3617

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

3618

"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.

3619

#

3620

# To see the latest fingerprint, make get() request to the instance.

3621

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3622

"a_key": "A String",

3623

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3624

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3625

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3626

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3627

"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:

3628

# zones/us-central1-f/machineTypes/n1-standard-1

3629

#

3630

#

3631

# 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):

3632

# zones/zone/machineTypes/custom-CPUS-MEMORY

3633

#

3634

#

3635

# For example: zones/us-central1-f/machineTypes/custom-4-5120

3636

#

3637

# For a full list of restrictions, read the Specifications for custom machine types.

3638

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

3639

"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.

3640

#

3641

# To see the latest fingerprint, make a get() request to retrieve the resource.

3642

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

3643

{

3644

"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.

3645

"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).

3646

},

3647

],

3648

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3649

},

3650

"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".

3651

"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.

3652

"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.

3653

{ # A network interface resource attached to an instance.

3654

"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.

3655

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3656

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

3657

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3658

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3659

"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.

3660

"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.

3661

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3662

#

3663

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3664

#

3665

# 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.

3666

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3667

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3668

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3669

"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.

3670

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3671

},

3672

],

3673

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3674

{ # An alias IP range attached to an instance's network interface.

3675

"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).

3676

"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.

3677

},

3678

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3679

"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-11-16 11:05:03 -0700

[diff] [blame]

3680

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

3681

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

3682

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3683

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

3684

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

3685

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3686

"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.

3687

"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.

3688

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

3689

#

3690

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

3691

#

3692

# 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.

3693

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

3694

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

3695

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

3696

"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.

3697

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3698

},

3699

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3700

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

3701

#

3702

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3703

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3704

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3705

"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.

3706

"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.

3707

#

3708

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

3709

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

3710

# - projects/project/global/networks/network

3711

# - global/networks/default

3712

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3713

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

3714

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

3715

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

3716

#

3717

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3718

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

3719

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

3720

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

3721

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3722

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

3723

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3724

# - regions/region/subnetworks/subnetwork

3725

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

3726

},

3727

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3728

"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:

3729

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

3730

# - regions/region/subnetworks/subnetwork

3731

},

3732

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3733

"networkPerformanceConfig": {

3734

"externalIpEgressBandwidthTier": "A String",

3735

"totalEgressBandwidthTier": "A String",

3736

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3737

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3738

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

3739

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

3740

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

3741

"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.

3742

"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.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

3743

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3748

"A String",

3749

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3750

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

3751

"scheduling": {

3752

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

3753

},

3754

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3755

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3756

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3757

"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.

3758

#

3759

# 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]

3760

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

3761

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3762

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

3763

"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]

3764

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

3765

"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]

3766

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3767

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3768

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3769

"key": "A String", # Corresponds to the label key of Node resource.

3770

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3771

"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]

3777

"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]

3778

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3779

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

3780

"A String",

3781

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3782

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3783

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3784

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

3785

#

3786

# 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.

3787

{ # A service account.

3788

"email": "A String", # Email address of the service account.

3789

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3795

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3796

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3797

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3798

},

3799

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3800

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3801

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3802

"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]

3803

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3804

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3805

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3806

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3807

"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]

3808

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3809

},

3810

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3811

"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]

3812

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3813

"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.

3814

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3815

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

3816

#

3817

# The key must meet the following requirements before you can provide it to Compute Engine:

3818

# - The key is wrapped using a RSA public key certificate provided by Google.

3819

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

3820

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

3821

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3822

},

3823

"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]

3824

"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]

3825

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3826

"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.

3827

"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.

3828

#

3829

# To see the latest fingerprint, make get() request to the instance.

3830

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3835

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3836

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

3837

"earliest": "A String",

3838

"latest": "A String",

3839

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3840

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3841

"type": "A String", # Defines the type of maintenance.

3842

},

3843

"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]

3844

}

3845

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3846

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.

3847

3848

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.

3849

3850

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

3851

secureTags: string, DEPRECATED: Please use resource.secure_tag instead. Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50. (repeated)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3852

sourceInstanceTemplate: string, Specifies instance template to create the instance.

3853

3854

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

3855

- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

3856

- projects/project/global/instanceTemplates/instanceTemplate

3857

- global/instanceTemplates/instanceTemplate

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3858

sourceMachineImage: string, Specifies the machine image to use to create the instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3859

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

3860

This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3861

- https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage

3862

- projects/project/global/global/machineImages/machineImage

3863

- global/machineImages/machineImage

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3864

3865

Returns:

3866

An object of the form:

3867

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3868

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3869

#

3870

# Google Compute Engine has three Operation resources:

3871

#

3872

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3873

#

3874

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3875

#

3876

# Operations can be global, regional or zonal.

3877

# - For global operations, use the `globalOperations` resource.

3878

# - For regional operations, use the `regionOperations` resource.

3879

# - For zonal operations, use the `zonalOperations` resource.

3880

#

3881

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3882

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3883

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3884

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3885

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3886

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3887

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3888

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3889

"code": "A String", # [Output Only] The error type identifier for this error.

3890

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3891

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3892

},

3893

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3894

},

3895

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3896

"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.

3897

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3898

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3899

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3900

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3901

"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]

3902

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3903

"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.

3904

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3905

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3906

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3907

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3908

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3909

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3910

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3911

"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.

3912

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3913

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3914

{

3915

"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.

3916

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3917

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3918

{

3919

"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).

3920

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3921

},

3922

],

3923

"message": "A String", # [Output Only] A human-readable description of the warning code.

3924

},

3925

],

3926

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3927

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3931

<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]

3932

<pre>Retrieves the list of instances contained within the specified zone.

3933

3934

Args:

3935

project: string, Project ID for this request. (required)

3936

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3937

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]

3938

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3939

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]

3940

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3941

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]

3942

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3943

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) ```

3944

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`)

3945

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3946

3947

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.

3948

3949

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3950

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]

3951

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]

3952

3953

Returns:

3954

An object of the form:

3955

3956

{ # Contains a list of instances.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3957

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3958

"items": [ # A list of Instance resources.

3959

{ # Represents an Instance resource.

3960

#

3961

# 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 ==)

3962

"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.

3963

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

3964

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3965

"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-31 13:33:30 -0700

[diff] [blame]

3966

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3967

},

3968

"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.

3969

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3970

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

3971

},

3972

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3973

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3974

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3975

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3976

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

3977

{ # An instance-attached disk resource.

3978

"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).

3979

"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.

3980

"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.

3981

#

3982

# 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.

3983

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

3984

#

3985

# 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.

3986

#

3987

# 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.

3988

#

3989

# 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.

3990

#

3991

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

3992

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3993

"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.

3994

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3995

"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]

3996

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3997

# The key must meet the following requirements before you can provide it to Compute Engine:

3998

# - The key is wrapped using a RSA public key certificate provided by Google.

3999

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4000

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4001

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4002

},

4003

"diskSizeGb": "A String", # The size of the disk in GB.

4004

"forceAttach": True or False, # [Input Only] 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.

4005

"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.

4006

{ # Guest OS features.

4007

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

4008

},

4009

],

4010

"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.

4011

"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.

4012

#

4013

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

4014

#

4015

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

4016

"description": "A String", # An optional description. Provide this property when creating the disk.

4017

"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.

4018

"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.

4019

"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:

4020

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4021

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4022

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4023

# 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:

4024

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

4025

# - projects/project/zones/zone/diskTypes/diskType

4026

# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

4027

"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]

4028

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4029

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

4030

{ # Guest OS features.

4031

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

4032

},

4033

],

4034

"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.

4035

"a_key": "A String",

4036

},

4037

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

4038

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

4039

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

4040

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

4041

"A String",

4042

],

4043

"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.

4044

"A String",

4045

],

4046

"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]

4047

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4048

# 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:

4049

# projects/debian-cloud/global/images/family/debian-9

4050

#

4051

#

4052

# Alternatively, use a specific version of a public operating system image:

4053

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

4054

#

4055

#

4056

# To create a disk with a custom image that you created, specify the image name in the following format:

4057

# global/images/my-custom-image

4058

#

4059

#

4060

# 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:

4061

# global/images/family/my-image-family

4062

#

4063

#

4064

# If the source image is deleted later, this field will not be set.

4065

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

4066

#

4067

# 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]

4068

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4069

"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.

4070

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4071

"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]

4072

#

4073

# The key must meet the following requirements before you can provide it to Compute Engine:

4074

# - 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]

4075

# - 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]

4076

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4077

"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]

4078

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4079

"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]

4080

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4081

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

4082

# global/snapshots/my-backup

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4083

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4084

#

4085

# If the source snapshot is deleted later, this field will not be set.

4086

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

4087

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4088

"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.

4089

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4090

"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]

4091

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4092

# The key must meet the following requirements before you can provide it to Compute Engine:

4093

# - The key is wrapped using a RSA public key certificate provided by Google.

4094

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4095

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4096

"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]

4097

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4098

},

4099

"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.

4100

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

4101

"licenses": [ # [Output Only] Any valid publicly visible licenses.

4102

"A String",

4103

],

4104

"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.

4105

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

4106

"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

4107

"dbs": [ # The Key Database (db).

4108

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4109

"content": "A String", # The raw content in the secure keys file.

4110

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4111

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4112

],

4113

"dbxs": [ # The forbidden key database (dbx).

4114

{

4115

"content": "A String", # The raw content in the secure keys file.

4116

"fileType": "A String", # The file type of source file.

4117

},

4118

],

4119

"keks": [ # The Key Exchange Key (KEK).

4120

{

4121

"content": "A String", # The raw content in the secure keys file.

4122

"fileType": "A String", # The file type of source file.

4123

},

4124

],

4125

"pk": { # The Platform Key (PK).

4126

"content": "A String", # The raw content in the secure keys file.

4127

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4128

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4129

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4130

"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]

4131

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4132

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4133

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4134

# Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

4135

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

4136

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4137

"A String",

4138

],

4139

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4140

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4141

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

4142

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

4143

},

4144

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

4145

"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.

4146

#

4147

# To see the latest fingerprint, make get() request to the instance.

4148

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

4149

{ # A specification of the type and number of accelerator cards attached to the instance.

4150

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4151

"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.

4152

},

4153

],

4154

"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.

4155

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4156

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

4157

#

4158

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

4159

#

4160

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

4161

#

4162

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

4163

#

4164

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

4165

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4166

"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.

4167

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4168

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4169

#

4170

# The key must meet the following requirements before you can provide it to Compute Engine:

4171

# - The key is wrapped using a RSA public key certificate provided by Google.

4172

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4173

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4174

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4175

},

4176

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

4177

"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.

4178

#

4179

# To see the latest fingerprint, make get() request to the instance.

4180

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

4181

"a_key": "A String",

4182

},

4183

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

4184

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

4185

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

4186

"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:

4187

# zones/us-central1-f/machineTypes/n1-standard-1

4188

#

4189

#

4190

# 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):

4191

# zones/zone/machineTypes/custom-CPUS-MEMORY

4192

#

4193

#

4194

# For example: zones/us-central1-f/machineTypes/custom-4-5120

4195

#

4196

# For a full list of restrictions, read the Specifications for custom machine types.

4197

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

4198

"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.

4199

#

4200

# To see the latest fingerprint, make a get() request to retrieve the resource.

4201

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

4202

{

4203

"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.

4204

"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).

4205

},

4206

],

4207

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

4208

},

4209

"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".

4210

"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.

4211

"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.

4212

{ # A network interface resource attached to an instance.

4213

"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.

4214

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4215

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

4216

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4217

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4218

"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.

4219

"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.

4220

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4221

#

4222

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4223

#

4224

# 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.

4225

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4226

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4227

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4228

"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.

4229

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4230

},

4231

],

4232

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4233

{ # An alias IP range attached to an instance's network interface.

4234

"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).

4235

"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.

4236

},

4237

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4238

"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]

4239

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

4240

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

4241

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4242

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

4243

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4244

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4245

"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.

4246

"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.

4247

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

4248

#

4249

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

4250

#

4251

# 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.

4252

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

4253

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4254

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

4255

"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.

4256

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4257

},

4258

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4259

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

4260

#

4261

# Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4262

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

4263

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4264

"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.

4265

"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.

4266

#

4267

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

4268

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

4269

# - projects/project/global/networks/network

4270

# - global/networks/default

4271

"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.

4272

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

4273

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

4274

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

4275

#

4276

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4277

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

4278

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

4279

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

4280

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4281

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

4282

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

4283

# - regions/region/subnetworks/subnetwork

4284

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

4285

},

4286

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4287

"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:

4288

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

4289

# - regions/region/subnetworks/subnetwork

4290

},

4291

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4292

"networkPerformanceConfig": {

4293

"externalIpEgressBandwidthTier": "A String",

4294

"totalEgressBandwidthTier": "A String",

4295

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4296

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

4297

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

4298

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

4299

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

4300

"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.

4301

"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.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

4302

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

4307

"A String",

4308

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4309

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

4310

"scheduling": {

4311

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

4312

},

4313

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4314

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4315

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4316

"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.

4317

#

4318

# 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]

4319

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

4320

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4321

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

4322

"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]

4323

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

4324

"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]

4325

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4326

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

4327

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

4328

"key": "A String", # Corresponds to the label key of Node resource.

4329

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4330

"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.

4336

"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.

4337

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4338

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4339

"A String",

4340

],

4341

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4342

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4343

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

4344

#

4345

# 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.

4346

{ # A service account.

4347

"email": "A String", # Email address of the service account.

4348

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

4354

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4355

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4356

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

4357

},

4358

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

4359

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4360

},

4361

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

4362

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

4363

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

4364

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

4365

},

4366

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

4367

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4368

},

4369

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4370

"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]

4371

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4372

"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.

4373

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4374

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4375

#

4376

# The key must meet the following requirements before you can provide it to Compute Engine:

4377

# - The key is wrapped using a RSA public key certificate provided by Google.

4378

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4379

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4380

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4381

},

4382

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

4383

"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.

4384

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

4385

"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.

4386

"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.

4387

#

4388

# To see the latest fingerprint, make get() request to the instance.

4389

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

4394

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4395

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

4396

"earliest": "A String",

4397

"latest": "A String",

4398

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4399

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

4400

"type": "A String", # Defines the type of maintenance.

4401

},

4402

"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]

4403

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4404

],

4405

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

4406

"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.

4407

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4408

"warning": { # [Output Only] Informational warning message.

4409

"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.

4410

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4411

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4412

{

4413

"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).

4414

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4415

},

4416

],

4417

"message": "A String", # [Output Only] A human-readable description of the warning code.

4418

},

4419

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4423

<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]

4424

<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]

4425

4426

Args:

4427

project: string, Project ID for this request. (required)

4428

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4429

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]

4430

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]

4431

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4432

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]

4433

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4434

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]

4435

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4436

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]

4437

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]

4438

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

4439

4440

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.

4441

4442

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4443

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]

4444

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]

4445

4446

Returns:

4447

An object of the form:

4448

4449

{ # Contains a list of instance referrers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4450

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

4451

"items": [ # A list of Reference resources.

4452

{ # Represents a reference to a resource.

4453

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

4454

"referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include:

4455

# - MEMBER_OF

4456

"referrer": "A String", # URL of the resource which refers to the target.

4457

"target": "A String", # URL of the resource to which this reference points.

4458

},

4459

],

4460

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

4461

"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.

4462

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

4463

"warning": { # [Output Only] Informational warning message.

4464

"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.

4465

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4466

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4467

{

4468

"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).

4469

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4470

},

4471

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4472

"message": "A String", # [Output Only] A human-readable description of the warning code.

4473

},

4474

}</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>

4479

<pre>Retrieves the next page of results.

4480

4481

Args:

4482

previous_request: The request for the previous page. (required)

4483

previous_response: The response from the request for the previous page. (required)

4484

4485

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4486

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

4487

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]

4492

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

4493

<pre>Retrieves the next page of results.

4494

4495

Args:

4496

previous_request: The request for the previous page. (required)

4497

previous_response: The response from the request for the previous page. (required)

4498

4499

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4500

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4501

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]

4506

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4507

<pre>Removes resource policies from an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4508

4509

Args:

4510

project: string, Project ID for this request. (required)

4511

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4512

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4513

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4514

The object takes the form of:

4515

4516

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4517

"resourcePolicies": [ # Resource policies to be removed from this instance.

4518

"A String",

4519

],

4520

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4521

4522

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.

4523

4524

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.

4525

4526

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]

4527

4528

Returns:

4529

An object of the form:

4530

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4531

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4532

#

4533

# Google Compute Engine has three Operation resources:

4534

#

4535

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4536

#

4537

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4538

#

4539

# Operations can be global, regional or zonal.

4540

# - For global operations, use the `globalOperations` resource.

4541

# - For regional operations, use the `regionOperations` resource.

4542

# - For zonal operations, use the `zonalOperations` resource.

4543

#

4544

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4545

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4546

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4547

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4548

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4549

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4550

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4551

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4552

"code": "A String", # [Output Only] The error type identifier for this error.

4553

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4554

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4555

},

4556

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4557

},

4558

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4559

"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.

4560

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4561

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4562

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4563

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4564

"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]

4565

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4566

"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.

4567

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4568

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4569

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4570

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4571

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4572

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4573

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4574

"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.

4575

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4576

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4577

{

4578

"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.

4579

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4580

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4581

{

4582

"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).

4583

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4584

},

4585

],

4586

"message": "A String", # [Output Only] A human-readable description of the warning code.

4587

},

4588

],

4589

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4590

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="reset">reset(project, zone, instance, requestId=None)</code>

4595

<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.

4596

4597

Args:

4598

project: string, Project ID for this request. (required)

4599

zone: string, The name of the zone for this request. (required)

4600

instance: string, Name of the instance scoping this request. (required)

4601

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.

4602

4603

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.

4604

4605

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4606

4607

Returns:

4608

An object of the form:

4609

4610

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4611

#

4612

# Google Compute Engine has three Operation resources:

4613

#

4614

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4615

#

4616

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4617

#

4618

# Operations can be global, regional or zonal.

4619

# - For global operations, use the `globalOperations` resource.

4620

# - For regional operations, use the `regionOperations` resource.

4621

# - For zonal operations, use the `zonalOperations` resource.

4622

#

4623

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4624

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4625

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4626

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4627

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4628

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4629

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4630

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4631

"code": "A String", # [Output Only] The error type identifier for this error.

4632

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4633

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4634

},

4635

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4636

},

4637

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4638

"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.

4639

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4640

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4641

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4642

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4643

"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]

4644

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4645

"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.

4646

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4647

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4648

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4649

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4650

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4651

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4652

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4653

"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.

4654

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4655

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4656

{

4657

"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.

4658

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4659

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4660

{

4661

"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).

4662

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4663

},

4664

],

4665

"message": "A String", # [Output Only] A human-readable description of the warning code.

4666

},

4667

],

4668

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4669

}</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]

4673

<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]

4674

<pre>Resumes an instance that was suspended using the instances().suspend method.

4675

4676

Args:

4677

project: string, Project ID for this request. (required)

4678

zone: string, The name of the zone for this request. (required)

4679

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4680

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4681

The object takes the form of:

4682

4683

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4684

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

4685

#

4686

# In order to resume the instance, the disk url and its corresponding key must be provided.

4687

#

4688

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

4689

{

4690

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

4691

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4692

"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.

4693

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4694

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4695

#

4696

# The key must meet the following requirements before you can provide it to Compute Engine:

4697

# - The key is wrapped using a RSA public key certificate provided by Google.

4698

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4699

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4700

"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]

4701

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4702

"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]

4703

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4704

],

4705

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

4706

#

4707

# 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.

4708

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4709

"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.

4710

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4711

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

4712

#

4713

# The key must meet the following requirements before you can provide it to Compute Engine:

4714

# - The key is wrapped using a RSA public key certificate provided by Google.

4715

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

4716

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

4717

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4718

},

4719

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4720

4721

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.

4722

4723

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.

4724

4725

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4726

4727

Returns:

4728

An object of the form:

4729

4730

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4731

#

4732

# Google Compute Engine has three Operation resources:

4733

#

4734

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4735

#

4736

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4737

#

4738

# Operations can be global, regional or zonal.

4739

# - For global operations, use the `globalOperations` resource.

4740

# - For regional operations, use the `regionOperations` resource.

4741

# - For zonal operations, use the `zonalOperations` resource.

4742

#

4743

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4744

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4745

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4746

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4747

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4748

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4749

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4750

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4751

"code": "A String", # [Output Only] The error type identifier for this error.

4752

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4753

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4754

},

4755

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4756

},

4757

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4758

"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.

4759

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4760

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4761

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4762

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4763

"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]

4764

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4765

"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.

4766

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4767

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4768

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

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>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4793

<code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance)</code>

4794

<pre>TODO(b/180520210): Add IAM permission for this API. Sends diagnostic interrupt to the instance.

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)

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4804

<code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None)</code>

4805

<pre>Sets deletion protection on the instance.

4806

4807

Args:

4808

project: string, Project ID for this request. (required)

4809

zone: string, The name of the zone for this request. (required)

4810

resource: string, Name or id of the resource for this request. (required)

4811

deletionProtection: boolean, Whether the resource should be protected against deletion.

4812

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.

4813

4814

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.

4815

4816

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

4817

4818

Returns:

4819

An object of the form:

4820

4821

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4822

#

4823

# Google Compute Engine has three Operation resources:

4824

#

4825

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4826

#

4827

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4828

#

4829

# Operations can be global, regional or zonal.

4830

# - For global operations, use the `globalOperations` resource.

4831

# - For regional operations, use the `regionOperations` resource.

4832

# - For zonal operations, use the `zonalOperations` resource.

4833

#

4834

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4835

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4836

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4837

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4838

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4839

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4840

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4841

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4842

"code": "A String", # [Output Only] The error type identifier for this error.

4843

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4844

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4845

},

4846

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4847

},

4848

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4849

"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.

4850

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4851

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4852

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4853

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4854

"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]

4855

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4856

"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.

4857

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4858

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4859

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4860

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4861

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4862

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4863

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4864

"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.

4865

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4866

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4867

{

4868

"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.

4869

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4870

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4871

{

4872

"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).

4873

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4874

},

4875

],

4876

"message": "A String", # [Output Only] A human-readable description of the warning code.

4877

},

4878

],

4879

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4880

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4884

<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]

4885

<pre>Sets the auto-delete flag for a disk attached to an instance.

4886

4887

Args:

4888

project: string, Project ID for this request. (required)

4889

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4890

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4891

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]

4892

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)

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).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4898

4899

Returns:

4900

An object of the form:

4901

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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.

Bu Sun Kim

2020-05-20 12:08:20 -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.

Bu Sun Kim

2020-05-20 12:08:20 -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

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4941

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4942

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4943

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4944

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4945

"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.

4946

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4947

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4948

{

4949

"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.

4950

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4951

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4952

{

4953

"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).

4954

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4955

},

4956

],

4957

"message": "A String", # [Output Only] A human-readable description of the warning code.

4958

},

4959

],

4960

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4961

}</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]

4965

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4966

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

4967

4968

Args:

4969

project: string, Project ID for this request. (required)

4970

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4971

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4972

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4973

The object takes the form of:

4974

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4975

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4976

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

4977

{ # Associates `members` with a `role`.

4978

"bindingId": "A String",

4979

"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]

4980

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4981

# 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]

4982

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4983

# 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]

4984

#

4985

# 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]

4986

#

4987

# Example (Comparison):

4988

#

4989

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

4990

#

4991

# Example (Equality):

4992

#

4993

# 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'"

4998

#

4999

# Example (Data Manipulation):

5000

#

5001

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5002

#

5003

# 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.

5004

"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.

5005

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5006

"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.

5007

"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.

5008

},

5009

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

5010

#

5011

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5012

#

5013

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5014

#

5015

# * `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`.

5020

#

5021

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5022

#

5023

# * `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.

5024

#

5025

# * `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.

5026

#

5027

# * `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`.

5032

"A String",

5033

],

5034

"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]

5035

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5036

],

5037

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

5038

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5039

#

5040

#

5041

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5042

# 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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5043

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5044

# 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).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5045

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5046

# **JSON example:**

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5047

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5048

# { "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]

5049

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5050

# **YAML example:**

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5051

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5052

# 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]

5053

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5054

# 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]

5055

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5056

{ # 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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5057

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5058

# 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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5059

#

5060

# Example Policy with multiple AuditConfigs:

5061

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5062

# { "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" ] } ] } ] }

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5063

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5064

# 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]

5065

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5066

{ # Provides the configuration for logging a type of permissions. Example:

5067

#

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5068

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5069

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5070

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

5071

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

5072

"A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5073

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5074

"ignoreChildExemptions": True or False,

5075

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5076

},

5077

],

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5082

},

5083

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5084

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5085

{ # Associates `members` with a `role`.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

5086

"bindingId": "A String",

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5087

"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.

5088

#

5089

# If the condition evaluates to `true`, then this binding applies to the current request.

5090

#

5091

# 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.

5092

#

5093

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5094

#

5095

# Example (Comparison):

5096

#

5097

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

5098

#

5099

# Example (Equality):

5100

#

5101

# 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'"

5106

#

5107

# Example (Data Manipulation):

5108

#

5109

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5110

#

5111

# 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.

5112

"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.

5113

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5114

"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.

5115

"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.

5116

},

5117

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5118

#

5119

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5120

#

5121

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5122

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5123

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5124

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

5125

#

5126

#

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5127

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

5128

#

5129

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5130

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5131

# * `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.

5132

#

5133

# * `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.

5134

#

5135

# * `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.

5136

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5137

#

5138

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5139

# * `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]

5140

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5141

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5142

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5143

},

5144

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5145

"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.

5146

#

5147

# **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.

5148

"iamOwned": True or False,

5149

"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.

5150

{ # A rule to be applied in a Policy.

5151

"action": "A String", # Required

5152

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

5153

{ # A condition to be met.

5154

"iam": "A String", # Trusted attributes supplied by the IAM system.

5155

"op": "A String", # An operator to apply the subject with.

5156

"svc": "A String", # Trusted attributes discharged by the service.

5157

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

5158

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

5164

"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.

5165

"A String",

5166

],

5167

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

5168

{ # Specifies what kind of log the caller must write

5169

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

5170

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

5171

"permissionType": "A String", # The type of the permission that was checked.

5172

},

5173

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

5174

},

5175

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

5176

#

5177

# 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.

5178

#

5179

# Field names correspond to IAM request parameters and field values are their respective values.

5180

#

5181

# 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.

5182

#

5183

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

5184

"customFields": [ # Custom fields.

5185

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

5186

"name": "A String", # Name is the field name.

5187

"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.

5188

},

5189

],

5190

"field": "A String", # The field value to attribute.

5191

"metric": "A String", # The metric to update.

5192

},

5193

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

5194

"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.

5199

"A String",

5200

],

5201

"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.

5207

#

5208

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5209

#

5210

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5211

#

5212

# * 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

5213

#

5214

# **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.

5215

#

5216

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5217

#

5218

# 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:

5225

5226

{ # 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.

5231

#

5232

# 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

5241

#

5242

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

5243

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

5244

{ # 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.

5245

#

5246

# 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.

5247

#

5248

# Example Policy with multiple AuditConfigs:

5249

#

5250

# { "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" ] } ] } ] }

5251

#

5252

# 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.

5253

"auditLogConfigs": [ # The configuration for logging of each type of permission.

5254

{ # Provides the configuration for logging a type of permissions. Example:

5255

#

5256

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

5257

#

5258

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

5259

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

5260

"A String",

5261

],

5262

"ignoreChildExemptions": True or False,

5263

"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.

5270

},

5271

],

5272

"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.

5273

{ # Associates `members` with a `role`.

5274

"bindingId": "A String",

5275

"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.

5276

#

5277

# If the condition evaluates to `true`, then this binding applies to the current request.

5278

#

5279

# 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.

5280

#

5281

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5282

#

5283

# Example (Comparison):

5284

#

5285

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

5286

#

5287

# Example (Equality):

5288

#

5289

# 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'"

5294

#

5295

# Example (Data Manipulation):

5296

#

5297

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

5298

#

5299

# 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.

5300

"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.

5301

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

5302

"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.

5303

"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.

5304

},

5305

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

5306

#

5307

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

5308

#

5309

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

5310

#

5311

# * `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`.

5316

#

5317

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

5318

#

5319

# * `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.

5320

#

5321

# * `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.

5322

#

5323

# * `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`.

5328

"A String",

5329

],

5330

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

5331

},

5332

],

5333

"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.

5334

#

5335

# **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.

5336

"iamOwned": True or False,

5337

"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.

5338

{ # A rule to be applied in a Policy.

5339

"action": "A String", # Required

5340

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

5341

{ # A condition to be met.

5342

"iam": "A String", # Trusted attributes supplied by the IAM system.

5343

"op": "A String", # An operator to apply the subject with.

5344

"svc": "A String", # Trusted attributes discharged by the service.

5345

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

5346

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

5352

"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.

5353

"A String",

5354

],

5355

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

5356

{ # Specifies what kind of log the caller must write

5357

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

5358

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

5359

"permissionType": "A String", # The type of the permission that was checked.

5360

},

5361

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

5362

},

5363

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

5364

#

5365

# 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.

5366

#

5367

# Field names correspond to IAM request parameters and field values are their respective values.

5368

#

5369

# 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.

5370

#

5371

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

5372

"customFields": [ # Custom fields.

5373

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

5374

"name": "A String", # Name is the field name.

5375

"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.

5376

},

5377

],

5378

"field": "A String", # The field value to attribute.

5379

"metric": "A String", # The metric to update.

5380

},

5381

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

5382

"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.

5387

"A String",

5388

],

5389

"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.

5395

#

5396

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

5397

#

5398

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

5399

#

5400

# * 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

5401

#

5402

# **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.

5403

#

5404

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

5405

#

5406

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

5407

}</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]

5411

<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]

5412

<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]

5413

5414

Args:

5415

project: string, Project ID for this request. (required)

5416

zone: string, The name of the zone for this request. (required)

5417

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5418

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5419

The object takes the form of:

5420

5421

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5422

"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]

5427

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5428

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.

5429

5430

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.

5431

5432

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]

5433

5434

Returns:

5435

An object of the form:

5436

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5437

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5438

#

5439

# Google Compute Engine has three Operation resources:

5440

#

5441

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5442

#

5443

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5444

#

5445

# Operations can be global, regional or zonal.

5446

# - For global operations, use the `globalOperations` resource.

5447

# - For regional operations, use the `regionOperations` resource.

5448

# - For zonal operations, use the `zonalOperations` resource.

5449

#

5450

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5451

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5452

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5453

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5454

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5455

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5456

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5457

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5458

"code": "A String", # [Output Only] The error type identifier for this error.

5459

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5460

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5461

},

5462

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5463

},

5464

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5465

"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.

5466

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5467

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5468

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5469

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5470

"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]

5471

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5472

"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.

5473

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5474

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5475

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5476

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5477

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5478

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5479

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5480

"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.

5481

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5482

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5483

{

5484

"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.

5485

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5486

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5487

{

5488

"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).

5489

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5490

},

5491

],

5492

"message": "A String", # [Output Only] A human-readable description of the warning code.

5493

},

5494

],

5495

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5496

}</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]

5500

<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]

5501

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

5502

5503

Args:

5504

project: string, Project ID for this request. (required)

5505

zone: string, The name of the zone for this request. (required)

5506

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5507

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5508

The object takes the form of:

5509

5510

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5511

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

5512

{ # A specification of the type and number of accelerator cards attached to the instance.

5513

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5514

"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.

5515

},

5516

],

5517

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5518

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5519

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.

5520

5521

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.

5522

5523

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]

5524

5525

Returns:

5526

An object of the form:

5527

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5528

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5529

#

5530

# Google Compute Engine has three Operation resources:

5531

#

5532

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5533

#

5534

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5535

#

5536

# Operations can be global, regional or zonal.

5537

# - For global operations, use the `globalOperations` resource.

5538

# - For regional operations, use the `regionOperations` resource.

5539

# - For zonal operations, use the `zonalOperations` resource.

5540

#

5541

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5542

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5543

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5544

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5545

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5546

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5547

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5548

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5549

"code": "A String", # [Output Only] The error type identifier for this error.

5550

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5551

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5552

},

5553

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5554

},

5555

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5556

"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.

5557

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5558

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5559

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5560

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5561

"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]

5562

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5563

"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.

5564

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5565

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5566

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5567

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5568

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5569

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5570

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5571

"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.

5572

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5573

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5574

{

5575

"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.

5576

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5577

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5578

{

5579

"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).

5580

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5581

},

5582

],

5583

"message": "A String", # [Output Only] A human-readable description of the warning code.

5584

},

5585

],

5586

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5587

}</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]

5591

<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]

5592

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

5593

5594

Args:

5595

project: string, Project ID for this request. (required)

5596

zone: string, The name of the zone for this request. (required)

5597

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5598

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5599

The object takes the form of:

5600

5601

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5602

"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

5603

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5604

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5605

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.

5606

5607

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.

5608

5609

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]

5610

5611

Returns:

5612

An object of the form:

5613

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5614

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5615

#

5616

# Google Compute Engine has three Operation resources:

5617

#

5618

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5619

#

5620

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5621

#

5622

# Operations can be global, regional or zonal.

5623

# - For global operations, use the `globalOperations` resource.

5624

# - For regional operations, use the `regionOperations` resource.

5625

# - For zonal operations, use the `zonalOperations` resource.

5626

#

5627

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5628

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5629

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5630

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5631

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5632

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5633

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5634

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5635

"code": "A String", # [Output Only] The error type identifier for this error.

5636

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5637

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5638

},

5639

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5640

},

5641

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5642

"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.

5643

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5644

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5645

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5646

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5647

"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]

5648

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5649

"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.

5650

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5651

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5652

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5653

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5654

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5655

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5656

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5657

"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.

5658

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5659

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5660

{

5661

"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.

5662

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5663

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5664

{

5665

"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).

5666

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5667

},

5668

],

5669

"message": "A String", # [Output Only] A human-readable description of the warning code.

5670

},

5671

],

5672

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5673

}</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]

5677

<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]

5678

<pre>Sets metadata for the specified instance to the data included in the request.

5679

5680

Args:

5681

project: string, Project ID for this request. (required)

5682

zone: string, The name of the zone for this request. (required)

5683

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5684

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5685

The object takes the form of:

5686

5687

{ # A metadata key/value entry.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5688

"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]

5689

#

5690

# 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]

5691

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

5692

{

5693

"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.

5694

"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).

5695

},

5696

],

5697

"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]

5698

}

5699

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5700

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.

5701

5702

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.

5703

5704

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]

5705

5706

Returns:

5707

An object of the form:

5708

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5709

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5710

#

5711

# Google Compute Engine has three Operation resources:

5712

#

5713

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5714

#

5715

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5716

#

5717

# Operations can be global, regional or zonal.

5718

# - For global operations, use the `globalOperations` resource.

5719

# - For regional operations, use the `regionOperations` resource.

5720

# - For zonal operations, use the `zonalOperations` resource.

5721

#

5722

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5723

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5724

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5725

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5726

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5727

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5728

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5729

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5730

"code": "A String", # [Output Only] The error type identifier for this error.

5731

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5732

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5733

},

5734

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5735

},

5736

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5737

"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.

5738

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5739

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5740

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5741

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5742

"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]

5743

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5744

"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.

5745

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5746

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5747

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5748

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5749

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5750

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5751

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5752

"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.

5753

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5754

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5755

{

5756

"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.

5757

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5758

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5759

{

5760

"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).

5761

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5762

},

5763

],

5764

"message": "A String", # [Output Only] A human-readable description of the warning code.

5765

},

5766

],

5767

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5768

}</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]

5772

<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]

5773

<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-03-13 12:12:03 -0400

[diff] [blame]

5774

5775

Args:

5776

project: string, Project ID for this request. (required)

5777

zone: string, The name of the zone for this request. (required)

5778

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5779

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5780

The object takes the form of:

5781

5782

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5783

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

5784

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5785

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5786

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.

5787

5788

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.

5789

5790

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]

5791

5792

Returns:

5793

An object of the form:

5794

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5795

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5796

#

5797

# Google Compute Engine has three Operation resources:

5798

#

5799

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5800

#

5801

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5802

#

5803

# Operations can be global, regional or zonal.

5804

# - For global operations, use the `globalOperations` resource.

5805

# - For regional operations, use the `regionOperations` resource.

5806

# - For zonal operations, use the `zonalOperations` resource.

5807

#

5808

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5809

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5810

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5811

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5812

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5813

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5814

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5815

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5816

"code": "A String", # [Output Only] The error type identifier for this error.

5817

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5818

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5819

},

5820

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5821

},

5822

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5823

"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.

5824

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5825

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5826

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5827

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5828

"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]

5829

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5830

"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.

5831

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5832

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5833

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5834

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5835

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5836

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5837

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5838

"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.

5839

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5840

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5841

{

5842

"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.

5843

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5844

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5845

{

5846

"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).

5847

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5848

},

5849

],

5850

"message": "A String", # [Output Only] A human-readable description of the warning code.

5851

},

5852

],

5853

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5854

}</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]

5858

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5859

<pre>Sets name of an instance.

5860

5861

Args:

5862

project: string, Project ID for this request. (required)

5863

zone: string, The name of the zone for this request. (required)

5864

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5865

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5866

The object takes the form of:

5867

5868

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5869

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

5870

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

5871

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5872

5873

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.

5874

5875

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.

5876

5877

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

5878

5879

Returns:

5880

An object of the form:

5881

5882

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5883

#

5884

# Google Compute Engine has three Operation resources:

5885

#

5886

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5887

#

5888

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5889

#

5890

# Operations can be global, regional or zonal.

5891

# - For global operations, use the `globalOperations` resource.

5892

# - For regional operations, use the `regionOperations` resource.

5893

# - For zonal operations, use the `zonalOperations` resource.

5894

#

5895

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

5896

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5897

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5898

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5899

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5900

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5901

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5902

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5903

"code": "A String", # [Output Only] The error type identifier for this error.

5904

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5905

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5906

},

5907

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5908

},

5909

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5910

"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.

5911

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5912

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5913

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5914

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5915

"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]

5916

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5917

"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.

5918

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5919

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5920

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5921

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5922

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5923

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5924

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5925

"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.

5926

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5927

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5928

{

5929

"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.

5930

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5931

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5932

{

5933

"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).

5934

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5935

},

5936

],

5937

"message": "A String", # [Output Only] A human-readable description of the warning code.

5938

},

5939

],

5940

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5941

}</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]

5945

<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]

5946

<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]

5947

5948

Args:

5949

project: string, Project ID for this request. (required)

5950

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5951

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5952

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5953

The object takes the form of:

5954

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

5955

{ # Sets the scheduling options for an Instance. NextID: 21

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5956

"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.

5957

#

5958

# 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]

5959

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

5960

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5961

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

5962

"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]

5963

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

5964

"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]

5965

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5966

"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]

5967

{ # 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]

5968

"key": "A String", # Corresponds to the label key of Node resource.

5969

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5970

"values": [ # Corresponds to the label values of Node resource.

5971

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5972

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5973

},

5974

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5975

"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]

5976

"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]

5977

}

5978

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5979

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.

5980

5981

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.

5982

5983

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]

5984

5985

Returns:

5986

An object of the form:

5987

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5988

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5989

#

5990

# Google Compute Engine has three Operation resources:

5991

#

5992

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5993

#

5994

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5995

#

5996

# Operations can be global, regional or zonal.

5997

# - For global operations, use the `globalOperations` resource.

5998

# - For regional operations, use the `regionOperations` resource.

5999

# - For zonal operations, use the `zonalOperations` resource.

6000

#

6001

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6002

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6003

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6004

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6005

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6006

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6007

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6008

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6009

"code": "A String", # [Output Only] The error type identifier for this error.

6010

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6011

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6012

},

6013

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6014

},

6015

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6016

"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.

6017

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6018

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6019

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6020

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6021

"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]

6022

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6023

"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.

6024

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6025

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6026

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6027

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6028

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6029

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6030

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6031

"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.

6032

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6033

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6034

{

6035

"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.

6036

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6037

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6038

{

6039

"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).

6040

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6041

},

6042

],

6043

"message": "A String", # [Output Only] A human-readable description of the warning code.

6044

},

6045

],

6046

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6047

}</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]

6051

<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]

6052

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6053

6054

Args:

6055

project: string, Project ID for this request. (required)

6056

zone: string, The name of the zone for this request. (required)

6057

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6058

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6059

The object takes the form of:

6060

6061

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6062

"email": "A String", # Email address of the service account.

6063

"scopes": [ # The list of scopes to be made available for this service account.

6064

"A String",

6065

],

6066

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6067

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6068

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.

6069

6070

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.

6071

6072

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]

6073

6074

Returns:

6075

An object of the form:

6076

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6077

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6078

#

6079

# Google Compute Engine has three Operation resources:

6080

#

6081

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6082

#

6083

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6084

#

6085

# Operations can be global, regional or zonal.

6086

# - For global operations, use the `globalOperations` resource.

6087

# - For regional operations, use the `regionOperations` resource.

6088

# - For zonal operations, use the `zonalOperations` resource.

6089

#

6090

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6091

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6092

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6093

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6094

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6095

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6096

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6097

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6098

"code": "A String", # [Output Only] The error type identifier for this error.

6099

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6100

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6101

},

6102

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6103

},

6104

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6105

"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.

6106

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6107

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6108

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6109

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6110

"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]

6111

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6112

"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.

6113

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6114

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6115

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6116

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6117

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6118

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6119

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6120

"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.

6121

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6122

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6123

{

6124

"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.

6125

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6126

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6127

{

6128

"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).

6129

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6130

},

6131

],

6132

"message": "A String", # [Output Only] A human-readable description of the warning code.

6133

},

6134

],

6135

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6136

}</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]

6140

<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]

6141

<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.

6142

6143

Args:

6144

project: string, Project ID for this request. (required)

6145

zone: string, The name of the zone for this request. (required)

6146

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6147

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6148

The object takes the form of:

6149

6150

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6151

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6152

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6153

6154

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.

6155

6156

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.

6157

6158

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6159

6160

Returns:

6161

An object of the form:

6162

6163

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6164

#

6165

# Google Compute Engine has three Operation resources:

6166

#

6167

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6168

#

6169

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6170

#

6171

# Operations can be global, regional or zonal.

6172

# - For global operations, use the `globalOperations` resource.

6173

# - For regional operations, use the `regionOperations` resource.

6174

# - For zonal operations, use the `zonalOperations` resource.

6175

#

6176

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6177

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6178

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6179

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6180

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6181

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6182

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6183

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6184

"code": "A String", # [Output Only] The error type identifier for this error.

6185

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6186

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6187

},

6188

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6189

},

6190

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6191

"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.

6192

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6193

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6194

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6195

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6196

"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]

6197

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6198

"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.

6199

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6200

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6201

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6202

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6203

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6204

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6205

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6206

"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.

6207

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6208

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6209

{

6210

"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.

6211

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6212

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6213

{

6214

"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).

6215

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6216

},

6217

],

6218

"message": "A String", # [Output Only] A human-readable description of the warning code.

6219

},

6220

],

6221

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6222

}</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]

6226

<code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6227

<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.

6228

6229

Args:

6230

project: string, Project ID for this request. (required)

6231

zone: string, The name of the zone for this request. (required)

6232

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6233

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6234

The object takes the form of:

6235

6236

{ # The policy describes the baseline against which VM instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6237

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6238

}

6239

6240

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.

6241

6242

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.

6243

6244

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

6245

6246

Returns:

6247

An object of the form:

6248

6249

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6250

#

6251

# Google Compute Engine has three Operation resources:

6252

#

6253

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6254

#

6255

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6256

#

6257

# Operations can be global, regional or zonal.

6258

# - For global operations, use the `globalOperations` resource.

6259

# - For regional operations, use the `regionOperations` resource.

6260

# - For zonal operations, use the `zonalOperations` resource.

6261

#

6262

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6263

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6264

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6265

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6266

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6267

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6268

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6269

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6270

"code": "A String", # [Output Only] The error type identifier for this error.

6271

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6272

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6273

},

6274

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6275

},

6276

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6277

"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.

6278

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6279

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6280

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6281

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6282

"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]

6283

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6284

"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.

6285

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6286

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6287

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6288

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6289

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6290

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6291

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6292

"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.

6293

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6294

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6295

{

6296

"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.

6297

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6298

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6299

{

6300

"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).

6301

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6302

},

6303

],

6304

"message": "A String", # [Output Only] A human-readable description of the warning code.

6305

},

6306

],

6307

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6308

}</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]

6312

<code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6313

<pre>Sets network tags for the specified instance to the data included in the request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6314

6315

Args:

6316

project: string, Project ID for this request. (required)

6317

zone: string, The name of the zone for this request. (required)

6318

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6319

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6320

The object takes the form of:

6321

6322

{ # A set of instance tags.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6323

"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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6324

#

6325

# To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6326

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

6327

"A String",

6328

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6329

}

6330

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6331

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.

6332

6333

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.

6334

6335

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]

6336

6337

Returns:

6338

An object of the form:

6339

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6340

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6341

#

6342

# Google Compute Engine has three Operation resources:

6343

#

6344

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6345

#

6346

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6347

#

6348

# Operations can be global, regional or zonal.

6349

# - For global operations, use the `globalOperations` resource.

6350

# - For regional operations, use the `regionOperations` resource.

6351

# - For zonal operations, use the `zonalOperations` resource.

6352

#

6353

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6354

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6355

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6356

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6357

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6358

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6359

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6360

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6361

"code": "A String", # [Output Only] The error type identifier for this error.

6362

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6363

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6364

},

6365

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6366

},

6367

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6368

"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.

6369

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6370

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6371

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6372

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6373

"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]

6374

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6375

"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.

6376

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6377

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6378

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6379

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6380

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6381

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6382

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6383

"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.

6384

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6385

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6386

{

6387

"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.

6388

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6389

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6390

{

6391

"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).

6392

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6393

},

6394

],

6395

"message": "A String", # [Output Only] A human-readable description of the warning code.

6396

},

6397

],

6398

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6399

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6403

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance)</code>

6404

<pre>Simulates a maintenance event on the instance.

6405

6406

Args:

6407

project: string, Project ID for this request. (required)

6408

zone: string, The name of the zone for this request. (required)

6409

instance: string, Name of the instance scoping this request. (required)

6410

6411

Returns:

6412

An object of the form:

6413

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6414

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6415

#

6416

# Google Compute Engine has three Operation resources:

6417

#

6418

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6419

#

6420

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6421

#

6422

# Operations can be global, regional or zonal.

6423

# - For global operations, use the `globalOperations` resource.

6424

# - For regional operations, use the `regionOperations` resource.

6425

# - For zonal operations, use the `zonalOperations` resource.

6426

#

6427

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6428

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6429

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6430

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6431

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6432

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6433

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6434

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6435

"code": "A String", # [Output Only] The error type identifier for this error.

6436

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6437

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6438

},

6439

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6440

},

6441

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6442

"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.

6443

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6444

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6445

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6446

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6447

"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]

6448

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6449

"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.

6450

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6451

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6452

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6453

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6454

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6455

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6456

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6457

"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.

6458

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6459

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6460

{

6461

"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.

6462

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6463

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6464

{

6465

"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).

6466

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6467

},

6468

],

6469

"message": "A String", # [Output Only] A human-readable description of the warning code.

6470

},

6471

],

6472

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6473

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

<code class="details" id="start">start(project, zone, instance, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6478

<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]

6479

6480

Args:

6481

project: string, Project ID for this request. (required)

6482

zone: string, The name of the zone for this request. (required)

6483

instance: string, Name of the instance resource to start. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6484

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.

6485

6486

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.

6487

6488

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]

6489

6490

Returns:

6491

An object of the form:

6492

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6493

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6494

#

6495

# Google Compute Engine has three Operation resources:

6496

#

6497

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6498

#

6499

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6500

#

6501

# Operations can be global, regional or zonal.

6502

# - For global operations, use the `globalOperations` resource.

6503

# - For regional operations, use the `regionOperations` resource.

6504

# - For zonal operations, use the `zonalOperations` resource.

6505

#

6506

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6507

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6508

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6509

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6510

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6511

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6512

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6513

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6514

"code": "A String", # [Output Only] The error type identifier for this error.

6515

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6516

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6517

},

6518

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6519

},

6520

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6521

"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.

6522

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6523

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6524

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6525

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6526

"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]

6527

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6528

"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.

6529

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6530

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6531

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6532

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6533

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6534

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6535

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6536

"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.

6537

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6538

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6539

{

6540

"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.

6541

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6542

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6543

{

6544

"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).

6545

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6546

},

6547

],

6548

"message": "A String", # [Output Only] A human-readable description of the warning code.

6549

},

6550

],

6551

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6552

}</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]

6556

<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]

6557

<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]

6558

6559

Args:

6560

project: string, Project ID for this request. (required)

6561

zone: string, The name of the zone for this request. (required)

6562

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6563

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6564

The object takes the form of:

6565

6566

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6567

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key.

6568

#

6569

# In order to start the instance, the disk url and its corresponding key must be provided.

6570

#

6571

# If the disk is not protected with a customer-supplied encryption key it should not be specified.

6572

{

6573

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

6574

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6575

"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.

6576

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6577

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6578

#

6579

# The key must meet the following requirements before you can provide it to Compute Engine:

6580

# - The key is wrapped using a RSA public key certificate provided by Google.

6581

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6582

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6583

"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]

6584

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6585

"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]

6586

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6587

],

6588

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key.

6589

#

6590

# If the instance you are starting is protected with a customer-supplied encryption key, the correct key must be provided otherwise the instance start will not succeed.

6591

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6592

"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.

6593

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6594

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6595

#

6596

# The key must meet the following requirements before you can provide it to Compute Engine:

6597

# - The key is wrapped using a RSA public key certificate provided by Google.

6598

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6599

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6600

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6601

},

6602

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6603

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6604

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.

6605

6606

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.

6607

6608

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]

6609

6610

Returns:

6611

An object of the form:

6612

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6613

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6614

#

6615

# Google Compute Engine has three Operation resources:

6616

#

6617

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6618

#

6619

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6620

#

6621

# Operations can be global, regional or zonal.

6622

# - For global operations, use the `globalOperations` resource.

6623

# - For regional operations, use the `regionOperations` resource.

6624

# - For zonal operations, use the `zonalOperations` resource.

6625

#

6626

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6627

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6628

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6629

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6630

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6631

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6632

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6633

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6634

"code": "A String", # [Output Only] The error type identifier for this error.

6635

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6636

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6637

},

6638

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6639

},

6640

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6641

"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.

6642

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6643

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6644

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6645

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6646

"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]

6647

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6648

"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.

6649

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6650

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6651

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6652

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6653

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6654

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6655

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6656

"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.

6657

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6658

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6659

{

6660

"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.

6661

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6662

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6663

{

6664

"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).

6665

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6666

},

6667

],

6668

"message": "A String", # [Output Only] A human-readable description of the warning code.

6669

},

6670

],

6671

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6672

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6676

<code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6677

<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]

6678

6679

Args:

6680

project: string, Project ID for this request. (required)

6681

zone: string, The name of the zone for this request. (required)

6682

instance: string, Name of the instance resource to stop. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6683

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6684

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.

6685

6686

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.

6687

6688

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]

6689

6690

Returns:

6691

An object of the form:

6692

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6693

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6694

#

6695

# Google Compute Engine has three Operation resources:

6696

#

6697

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6698

#

6699

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6700

#

6701

# Operations can be global, regional or zonal.

6702

# - For global operations, use the `globalOperations` resource.

6703

# - For regional operations, use the `regionOperations` resource.

6704

# - For zonal operations, use the `zonalOperations` resource.

6705

#

6706

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6707

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6708

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6709

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6710

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6711

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6712

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6713

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6714

"code": "A String", # [Output Only] The error type identifier for this error.

6715

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6716

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6717

},

6718

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6719

},

6720

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6721

"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.

6722

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6723

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6724

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6725

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6726

"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]

6727

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6728

"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.

6729

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6730

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6731

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6732

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6733

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6734

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6735

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6736

"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.

6737

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6738

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6739

{

6740

"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.

6741

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6742

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6743

{

6744

"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).

6745

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6746

},

6747

],

6748

"message": "A String", # [Output Only] A human-readable description of the warning code.

6749

},

6750

],

6751

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6752

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6756

<code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6757

<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.

6758

6759

Args:

6760

project: string, Project ID for this request. (required)

6761

zone: string, The name of the zone for this request. (required)

6762

instance: string, Name of the instance resource to suspend. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

6763

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6764

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.

6765

6766

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.

6767

6768

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]

6769

6770

Returns:

6771

An object of the form:

6772

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6773

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6774

#

6775

# Google Compute Engine has three Operation resources:

6776

#

6777

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

6778

#

6779

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

6780

#

6781

# Operations can be global, regional or zonal.

6782

# - For global operations, use the `globalOperations` resource.

6783

# - For regional operations, use the `regionOperations` resource.

6784

# - For zonal operations, use the `zonalOperations` resource.

6785

#

6786

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

6787

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6788

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6789

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6790

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6791

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6792

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6793

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6794

"code": "A String", # [Output Only] The error type identifier for this error.

6795

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6796

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6797

},

6798

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6799

},

6800

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6801

"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.

6802

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6803

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6804

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6805

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6806

"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]

6807

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6808

"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.

6809

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6810

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6811

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6812

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6813

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6814

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6815

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6816

"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.

6817

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6818

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6819

{

6820

"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.

6821

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

6822

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

6823

{

6824

"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).

6825

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6826

},

6827

],

6828

"message": "A String", # [Output Only] A human-readable description of the warning code.

6829

},

6830

],

6831

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6832

}</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]

6836

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6837

<pre>Returns permissions that a caller has on the specified resource.

6838

6839

Args:

6840

project: string, Project ID for this request. (required)

6841

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6842

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6843

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6844

The object takes the form of:

6845

6846

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6847

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

6848

"A String",

6849

],

6850

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

Returns:

An object of the form:

6855

6856

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6857

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

6858

"A String",

6859

],

6860

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

6864

<code class="details" id="update">update(project, zone, instance, body=None, clearSecureTag=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, secureTags=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6865

<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.

6866

6867

Args:

6868

project: string, Project ID for this request. (required)

6869

zone: string, The name of the zone for this request. (required)

6870

instance: string, Name of the instance resource to update. (required)

6871

body: object, The request body.

6872

The object takes the form of:

6873

6874

{ # Represents an Instance resource.

6875

#

6876

# 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 ==)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6877

"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.

6878

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

6879

"numaNodeCount": 42, # The number of vNUMA nodes.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6880

"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-31 13:33:30 -0700

[diff] [blame]

6881

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6882

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6883

"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.

6884

"confidentialInstanceConfig": { # A set of Confidential Instance options.

6885

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6886

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6887

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

6888

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

6889

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

6890

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6891

"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]

6892

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6893

"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).

6894

"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.

6895

"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.

6896

#

6897

# 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]

6898

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6899

#

6900

# 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.

6901

#

6902

# 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.

6903

#

6904

# 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.

6905

#

6906

# 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]

6907

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6908

"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.

6909

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6910

"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]

6911

#

6912

# The key must meet the following requirements before you can provide it to Compute Engine:

6913

# - The key is wrapped using a RSA public key certificate provided by Google.

6914

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6915

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6916

"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]

6917

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6918

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6919

"forceAttach": True or False, # [Input Only] 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

2020-05-20 12:08:20 -0700

[diff] [blame]

6920

"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.

6921

{ # Guest OS features.

6922

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

6923

},

6924

],

6925

"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.

6926

"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]

6927

#

6928

# This property is mutually exclusive with the source property; you can only define one or the other, but not both.

6929

#

6930

# 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]

6931

"description": "A String", # An optional description. Provide this property when creating the disk.

6932

"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.

6933

"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.

6934

"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]

6935

# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

6936

#

6937

#

6938

# 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:

6939

# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType

6940

# - projects/project/zones/zone/diskTypes/diskType

6941

# - 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]

6942

"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]

6943

#

6944

# Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

6945

{ # Guest OS features.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6946

"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]

6947

},

6948

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6949

"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.

6950

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6951

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6952

"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]

6953

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6954

"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]

6955

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

6956

"A String",

6957

],

6958

"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.

6959

"A String",

6960

],

6961

"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]

6962

#

6963

# 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:

6964

# projects/debian-cloud/global/images/family/debian-9

6965

#

6966

#

6967

# Alternatively, use a specific version of a public operating system image:

6968

# projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

6969

#

6970

#

6971

# To create a disk with a custom image that you created, specify the image name in the following format:

6972

# global/images/my-custom-image

6973

#

6974

#

6975

# 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:

6976

# global/images/family/my-image-family

6977

#

6978

#

6979

# If the source image is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6980

"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]

6981

#

6982

# 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.

6983

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

6984

"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.

6985

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

6986

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

6987

#

6988

# The key must meet the following requirements before you can provide it to Compute Engine:

6989

# - The key is wrapped using a RSA public key certificate provided by Google.

6990

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

6991

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

6992

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

6993

},

6994

"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.

6995

#

6996

# To create a disk with a snapshot that you created, specify the snapshot name in the following format:

6997

# global/snapshots/my-backup

6998

#

6999

#

7000

# If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7001

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7002

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7003

"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.

7004

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7005

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7006

#

7007

# The key must meet the following requirements before you can provide it to Compute Engine:

7008

# - The key is wrapped using a RSA public key certificate provided by Google.

7009

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7010

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7011

"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]

7012

},

7013

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7014

"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.

7015

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

7016

"licenses": [ # [Output Only] Any valid publicly visible licenses.

7017

"A String",

7018

],

7019

"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.

7020

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

7021

"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

7022

"dbs": [ # The Key Database (db).

7023

{

7024

"content": "A String", # The raw content in the secure keys file.

7025

"fileType": "A String", # The file type of source file.

7026

},

7027

],

7028

"dbxs": [ # The forbidden key database (dbx).

7029

{

7030

"content": "A String", # The raw content in the secure keys file.

7031

"fileType": "A String", # The file type of source file.

7032

},

7033

],

7034

"keks": [ # The Key Exchange Key (KEK).

7035

{

7036

"content": "A String", # The raw content in the secure keys file.

7037

"fileType": "A String", # The file type of source file.

7038

},

7039

],

7040

"pk": { # The Platform Key (PK).

7041

"content": "A String", # The raw content in the secure keys file.

7042

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7043

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7044

},

7045

"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]

7046

#

7047

# If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

7048

#

7049

# 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]

7050

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7051

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

7052

"A String",

7053

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7054

},

7055

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7056

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

7057

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7058

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7059

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

7060

"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.

7061

#

7062

# To see the latest fingerprint, make get() request to the instance.

7063

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

7064

{ # A specification of the type and number of accelerator cards attached to the instance.

7065

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

7066

"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.

7067

},

7068

],

7069

"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.

7070

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7071

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7072

#

7073

# If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide.

7074

#

7075

# If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance.

7076

#

7077

# If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later.

7078

#

7079

# Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

7080

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7081

"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.

7082

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7083

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7084

#

7085

# The key must meet the following requirements before you can provide it to Compute Engine:

7086

# - The key is wrapped using a RSA public key certificate provided by Google.

7087

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7088

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7089

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

7090

},

7091

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

7092

"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.

7093

#

7094

# To see the latest fingerprint, make get() request to the instance.

7095

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

7096

"a_key": "A String",

7097

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

7098

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

7099

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

7100

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7101

"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:

7102

# zones/us-central1-f/machineTypes/n1-standard-1

7103

#

7104

#

7105

# 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):

7106

# zones/zone/machineTypes/custom-CPUS-MEMORY

7107

#

7108

#

7109

# For example: zones/us-central1-f/machineTypes/custom-4-5120

7110

#

7111

# For a full list of restrictions, read the Specifications for custom machine types.

7112

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

7113

"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.

7114

#

7115

# To see the latest fingerprint, make a get() request to retrieve the resource.

7116

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

7117

{

7118

"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.

7119

"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).

7120

},

7121

],

7122

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

7123

},

7124

"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".

7125

"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.

7126

"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.

7127

{ # A network interface resource attached to an instance.

7128

"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.

7129

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7130

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7131

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7132

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7133

"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.

7134

"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.

7135

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7136

#

7137

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7138

#

7139

# 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.

7140

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7141

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7142

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7143

"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.

7144

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7145

},

7146

],

7147

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

7148

{ # An alias IP range attached to an instance's network interface.

7149

"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).

7150

"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.

7151

},

7152

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7153

"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-11-16 11:05:03 -0700

[diff] [blame]

7154

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

7155

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

7156

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

7157

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7158

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

7159

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7160

"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.

7161

"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.

7162

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7163

#

7164

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7165

#

7166

# 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.

7167

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7168

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7169

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7170

"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.

7171

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7172

},

7173

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7174

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

7175

#

7176

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7177

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

7178

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

7179

"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.

7180

"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.

7181

#

7182

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

7183

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

7184

# - projects/project/global/networks/network

7185

# - global/networks/default

7186

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7187

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

7188

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

7189

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

7190

#

7191

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7192

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

7193

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

7194

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

7195

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7196

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

7197

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7198

# - regions/region/subnetworks/subnetwork

7199

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

7200

},

7201

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7202

"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:

7203

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7204

# - regions/region/subnetworks/subnetwork

7205

},

7206

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7207

"networkPerformanceConfig": {

7208

"externalIpEgressBandwidthTier": "A String",

7209

"totalEgressBandwidthTier": "A String",

7210

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7211

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7212

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

7213

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

7214

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

7215

"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.

7216

"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.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

7217

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

7222

"A String",

7223

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7224

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

7225

"scheduling": {

7226

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

7227

},

7228

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7229

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

7230

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7231

"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.

7232

#

7233

# 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]

7234

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

7235

"hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7236

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

7237

"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]

7238

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

7239

"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]

7240

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

7241

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

7242

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

7243

"key": "A String", # Corresponds to the label key of Node resource.

7244

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

7245

"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]

7251

"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]

7252

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

7253

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

7254

"A String",

7255

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7256

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

7257

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7258

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

7259

#

7260

# 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.

7261

{ # A service account.

7262

"email": "A String", # Email address of the service account.

7263

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

7269

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7270

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7271

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

7272

},

7273

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

7274

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

7275

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7276

"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]

7277

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7278

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7279

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

7280

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7281

"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]

7282

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

7283

},

7284

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7285

"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]

7286

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

7287

"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.

7288

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

7289

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

7290

#

7291

# The key must meet the following requirements before you can provide it to Compute Engine:

7292

# - The key is wrapped using a RSA public key certificate provided by Google.

7293

# - After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at:

7294

# https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

7295

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

7296

},

7297

"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]

7298

"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]

7299

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

7300

"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.

7301

"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.

7302

#

7303

# To see the latest fingerprint, make get() request to the instance.

7304

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"upcomingMaintenance": { # Upcoming Maintenance notification information. # [Output Only] Specifies upcoming maintenance for the instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7309

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7310

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

7311

"earliest": "A String",

7312

"latest": "A String",

7313

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

7314

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7315

"type": "A String", # Defines the type of maintenance.

7316

},

7317

"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]

7318

}

7319

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

7320

clearSecureTag: boolean, Whether to clear secure tags from the instance.

7321

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

7322

This property if set to true will clear secure tags regardless of the resource.secure_tags.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7323

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]

7329

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]

7335

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.

7336

7337

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.

7338

7339

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

7340

secureTags: string, DEPRECATED: Please use resource.secure_tag instead. Secure tags to apply to this instance. Maximum number of secure tags allowed is 50. (repeated)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7341

7342

Returns:

7343

An object of the form:

7344

7345

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7346

#

7347

# Google Compute Engine has three Operation resources:

7348

#

7349

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7350

#

7351

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7352

#

7353

# Operations can be global, regional or zonal.

7354

# - For global operations, use the `globalOperations` resource.

7355

# - For regional operations, use the `regionOperations` resource.

7356

# - For zonal operations, use the `zonalOperations` resource.

7357

#

7358

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7359

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7360

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7361

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7362

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7363

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7364

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7365

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7366

"code": "A String", # [Output Only] The error type identifier for this error.

7367

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7368

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7369

},

7370

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7371

},

7372

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7373

"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.

7374

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7375

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7376

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7377

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7378

"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]

7379

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7380

"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.

7381

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7382

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7383

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7384

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7385

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7386

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7387

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7388

"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.

7389

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7390

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7391

{

7392

"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.

7393

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7394

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7395

{

7396

"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).

7397

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7398

},

7399

],

7400

"message": "A String", # [Output Only] A human-readable description of the warning code.

7401

},

7402

],

7403

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7404

}</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]

7409

<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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7410

7411

Args:

7412

project: string, Project ID for this request. (required)

7413

zone: string, The name of the zone for this request. (required)

7414

instance: string, The instance name for this request. (required)

7415

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]

7416

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7417

The object takes the form of:

7418

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7419

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7420

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7421

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7422

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7423

"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.

7424

"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.

7425

"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]

7426

#

7427

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7428

#

7429

# 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]

7430

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7431

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7432

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7433

"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.

7434

"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]

7435

}

7436

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7437

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.

7438

7439

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.

7440

7441

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]

7442

7443

Returns:

7444

An object of the form:

7445

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7446

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7447

#

7448

# Google Compute Engine has three Operation resources:

7449

#

7450

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7451

#

7452

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7453

#

7454

# Operations can be global, regional or zonal.

7455

# - For global operations, use the `globalOperations` resource.

7456

# - For regional operations, use the `regionOperations` resource.

7457

# - For zonal operations, use the `zonalOperations` resource.

7458

#

7459

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7460

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7461

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7462

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7463

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7464

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7465

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7466

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7467

"code": "A String", # [Output Only] The error type identifier for this error.

7468

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7469

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7470

},

7471

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7472

},

7473

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7474

"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.

7475

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7476

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7477

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7478

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7479

"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]

7480

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7481

"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.

7482

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7483

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7484

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7485

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7486

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7487

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7488

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7489

"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.

7490

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7491

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7492

{

7493

"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.

7494

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7495

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7496

{

7497

"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).

7498

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7499

},

7500

],

7501

"message": "A String", # [Output Only] A human-readable description of the warning code.

7502

},

7503

],

7504

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7505

}</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]

7509

<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]

7510

<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.

7511

7512

Args:

7513

project: string, Project ID for this request. (required)

7514

zone: string, The name of the zone for this request. (required)

7515

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7516

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7517

The object takes the form of:

7518

7519

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7520

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7521

}

7522

7523

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.

7524

7525

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.

7526

7527

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7528

7529

Returns:

7530

An object of the form:

7531

7532

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7533

#

7534

# Google Compute Engine has three Operation resources:

7535

#

7536

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7537

#

7538

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7539

#

7540

# Operations can be global, regional or zonal.

7541

# - For global operations, use the `globalOperations` resource.

7542

# - For regional operations, use the `regionOperations` resource.

7543

# - For zonal operations, use the `zonalOperations` resource.

7544

#

7545

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7546

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7547

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7548

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7549

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7550

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7551

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7552

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7553

"code": "A String", # [Output Only] The error type identifier for this error.

7554

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7555

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7556

},

7557

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7558

},

7559

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7560

"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.

7561

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7562

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7563

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7564

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7565

"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]

7566

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7567

"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.

7568

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7569

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7570

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7571

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7572

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7573

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7574

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7575

"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.

7576

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7577

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7578

{

7579

"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.

7580

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7581

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7582

{

7583

"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).

7584

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7585

},

7586

],

7587

"message": "A String", # [Output Only] A human-readable description of the warning code.

7588

},

7589

],

7590

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7591

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

7592

</div>

7593

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7594

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7595

<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]

7596

<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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7597

7598

Args:

7599

project: string, Project ID for this request. (required)

7600

zone: string, The name of the zone for this request. (required)

7601

instance: string, The instance name for this request. (required)

7602

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7603

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7604

The object takes the form of:

7605

7606

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7607

"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.

7608

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7609

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7610

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7611

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7612

"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.

7613

"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.

7614

"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]

7615

#

7616

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7617

#

7618

# 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]

7619

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7620

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7621

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7622

"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.

7623

"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]

7624

},

7625

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7626

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

7627

{ # An alias IP range attached to an instance's network interface.

7628

"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).

7629

"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.

7630

},

7631

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

7632

"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-11-16 11:05:03 -0700

[diff] [blame]

7633

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

7634

"ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

7635

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

7636

"externalIpv6": "A String", # [Output Only] The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. The field is output only, an IPv6 address from a subnetwork associated with the instance will be allocated dynamically.

7637

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

7638

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

7639

"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.

7640

"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.

7641

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.

7642

#

7643

# If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.

7644

#

7645

# 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.

7646

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

7647

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

7648

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

7649

"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.

7650

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

7651

},

7652

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7653

"ipv6AccessType": "A String", # [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.

7654

#

7655

# Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7656

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

7657

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

7658

"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.

7659

"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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7660

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7661

# If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:

7662

# - https://www.googleapis.com/compute/v1/projects/project/global/networks/network

7663

# - projects/project/global/networks/network

7664

# - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7665

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

7666

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

7667

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

7668

"stackType": "A String", # The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used.

7669

#

7670

# This field can be both set at instance creation and update network interface operations.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7671

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

7672

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame^]

7673

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

7674

"ipAllocationMode": "A String",

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7675

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

7676

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7677

# - regions/region/subnetworks/subnetwork

7678

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

7679

},

7680

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7681

"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:

7682

# - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork

7683

# - regions/region/subnetworks/subnetwork

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

7684

}

7685

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7686

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.

7687

7688

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.

7689

7690

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]

7691

7692

Returns:

7693

An object of the form:

7694

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7695

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7696

#

7697

# Google Compute Engine has three Operation resources:

7698

#

7699

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7700

#

7701

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7702

#

7703

# Operations can be global, regional or zonal.

7704

# - For global operations, use the `globalOperations` resource.

7705

# - For regional operations, use the `regionOperations` resource.

7706

# - For zonal operations, use the `zonalOperations` resource.

7707

#

7708

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7709

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7710

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7711

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7712

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7713

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7714

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7715

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7716

"code": "A String", # [Output Only] The error type identifier for this error.

7717

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7718

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7719

},

7720

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7721

},

7722

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7723

"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.

7724

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7725

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7726

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7727

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7728

"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]

7729

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7730

"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.

7731

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7732

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7733

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7734

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7735

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7736

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7737

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7738

"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.

7739

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7740

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7741

{

7742

"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.

7743

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7744

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7745

{

7746

"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).

7747

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7748

},

7749

],

7750

"message": "A String", # [Output Only] A human-readable description of the warning code.

7751

},

7752

],

7753

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7754

}</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]

7758

<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]

7759

<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.

7760

7761

Args:

7762

project: string, Project ID for this request. (required)

7763

zone: string, The name of the zone for this request. (required)

7764

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7765

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7766

The object takes the form of:

7767

7768

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7769

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

7770

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

7771

"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]

7772

}

7773

7774

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.

7775

7776

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.

7777

7778

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7779

7780

Returns:

7781

An object of the form:

7782

7783

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7784

#

7785

# Google Compute Engine has three Operation resources:

7786

#

7787

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7788

#

7789

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7790

#

7791

# Operations can be global, regional or zonal.

7792

# - For global operations, use the `globalOperations` resource.

7793

# - For regional operations, use the `regionOperations` resource.

7794

# - For zonal operations, use the `zonalOperations` resource.

7795

#

7796

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7797

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7798

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7799

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7800

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7801

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7802

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7803

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7804

"code": "A String", # [Output Only] The error type identifier for this error.

7805

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7806

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7807

},

7808

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7809

},

7810

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7811

"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.

7812

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7813

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7814

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7815

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7816

"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]

7817

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

7818

"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.

7819

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

7820

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

7821

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

7822

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

7823

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

7824

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

7825

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

7826

"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.

7827

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

7828

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

7829

{

7830

"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.

7831

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

7832

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

7833

{

7834

"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).

7835

"value": "A String", # [Output Only] A warning data value corresponding to the key.

7836

},

7837

],

7838

"message": "A String", # [Output Only] A human-readable description of the warning code.

7839

},

7840

],

7841

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

7842

}</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]

7846

<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]

7847

<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.

7848

7849

Args:

7850

project: string, Project ID for this request. (required)

7851

zone: string, The name of the zone for this request. (required)

7852

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

7853

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7854

The object takes the form of:

7855

7856

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7857

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

7858

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

7859

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

7860

}

7861

7862

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.

7863

7864

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.

7865

7866

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

7867

7868

Returns:

7869

An object of the form:

7870

7871

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7872

#

7873

# Google Compute Engine has three Operation resources:

7874

#

7875

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

7876

#

7877

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

7878

#

7879

# Operations can be global, regional or zonal.

7880

# - For global operations, use the `globalOperations` resource.

7881

# - For regional operations, use the `regionOperations` resource.

7882

# - For zonal operations, use the `zonalOperations` resource.

7883

#

7884

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

7885

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

7886

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

7887

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

7888

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

7889

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

7890

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7891

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7892

"code": "A String", # [Output Only] The error type identifier for this error.

7893

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

7894

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

7895

},

7896

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

7897

},

7898

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

7899

"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.

7900

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

7901

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

7902

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

7903

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

7904

"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