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

2021-06-16 00:22:06 -0700

[diff] [blame]

84

<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

90

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

Sai Cheemalapati

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

[diff] [blame]

91

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

Sai Cheemalapati

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

[diff] [blame]

92

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

93

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

yoshi-code-bot

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

[diff] [blame]

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

99

<code><a href="#delete">delete(project, zone, instance, requestId=None, x__xgafv=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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

102

<code><a href="#deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

105

<code><a href="#detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

108

<code><a href="#get">get(project, zone, instance, x__xgafv=None)</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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

111

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

Dan O'Meara

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

[diff] [blame]

112

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

113

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

Sai Cheemalapati

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

[diff] [blame]

119

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

120

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

Dan O'Meara

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

[diff] [blame]

121

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

122

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

123

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

126

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

Bu Sun Kim

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

[diff] [blame]

127

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

128

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

129

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

Bu Sun Kim

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

[diff] [blame]

130

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

131

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

132

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

135

<code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

138

<code><a href="#listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

147

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

Dan O'Meara

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

[diff] [blame]

148

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

149

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

150

<code><a href="#reset">reset(project, zone, instance, requestId=None, x__xgafv=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>

Sai Cheemalapati

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

[diff] [blame]

152

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

153

<code><a href="#resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=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-06-16 00:22:06 -0700

[diff] [blame]

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

158

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

159

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

Sai Cheemalapati

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

[diff] [blame]

160

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

161

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

162

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

Bu Sun Kim

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

[diff] [blame]

163

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

Sai Cheemalapati

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

[diff] [blame]

164

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

165

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

Bu Sun Kim

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

[diff] [blame]

166

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

167

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

168

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

Sai Cheemalapati

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

[diff] [blame]

169

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

170

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

171

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

Sai Cheemalapati

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

[diff] [blame]

172

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

173

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

174

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

Sai Cheemalapati

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

[diff] [blame]

175

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

176

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

177

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

Bu Sun Kim

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

[diff] [blame]

178

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

Sai Cheemalapati

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

[diff] [blame]

179

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

180

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

Dmitry Frenkel

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

[diff] [blame]

181

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

182

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

183

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

Bu Sun Kim

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

[diff] [blame]

184

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

Sai Cheemalapati

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

[diff] [blame]

185

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

186

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

Sai Cheemalapati

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

[diff] [blame]

187

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

Jon Wayne Parrott

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

[diff] [blame]

188

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

189

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

Bu Sun Kim

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

[diff] [blame]

190

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

Sai Cheemalapati

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

[diff] [blame]

191

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

192

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

Bu Sun Kim

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

[diff] [blame]

193

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

Sai Cheemalapati

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

[diff] [blame]

194

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

195

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

Bu Sun Kim

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

[diff] [blame]

196

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

Sai Cheemalapati

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

[diff] [blame]

197

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

198

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

Bu Sun Kim

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

[diff] [blame]

199

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

200

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

201

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

Bu Sun Kim

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

[diff] [blame]

202

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

203

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

204

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

Bu Sun Kim

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

[diff] [blame]

205

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

206

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

207

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

Bu Sun Kim

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

[diff] [blame]

208

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

209

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

210

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

Bu Sun Kim

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

[diff] [blame]

211

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

Sai Cheemalapati

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

[diff] [blame]

212

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

213

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

Sai Cheemalapati

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

[diff] [blame]

214

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

Bu Sun Kim

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

[diff] [blame]

215

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

216

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

217

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

Dan O'Meara

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

[diff] [blame]

218

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

219

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

Bu Sun Kim

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

[diff] [blame]

220

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

221

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

222

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

Bu Sun Kim

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

[diff] [blame]

223

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

224

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

225

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

yoshi-code-bot

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

[diff] [blame]

226

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

Bu Sun Kim

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

[diff] [blame]

227

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

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

230

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

231

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

Bu Sun Kim

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

[diff] [blame]

232

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

Sai Cheemalapati

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

[diff] [blame]

233

<h3>Method Details</h3>

234

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

235

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

Bu Sun Kim

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

[diff] [blame]

236

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

Sai Cheemalapati

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

[diff] [blame]

237

238

Args:

239

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

240

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

241

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

242

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

Dan O'Meara

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

[diff] [blame]

243

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

244

The object takes the form of:

245

Bu Sun Kim

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

[diff] [blame]

246

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

yoshi-code-bot

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

[diff] [blame]

247

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

248

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

Bu Sun Kim

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

[diff] [blame]

249

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

250

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

251

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

252

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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]

253

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

254

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

255

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

256

}

257

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

258

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

259

x__xgafv: string, V1 error format.

260

Allowed values

261

1 - v1 error format

262

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

263

264

Returns:

265

An object of the form:

266

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

267

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

268

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

269

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

270

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

271

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

272

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

273

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

Bu Sun Kim

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

[diff] [blame]

274

{

Yoshi Automation Bot

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

[diff] [blame]

275

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

276

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

277

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

Bu Sun Kim

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

[diff] [blame]

278

},

279

],

Yoshi Automation Bot

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

[diff] [blame]

280

},

281

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

282

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

283

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

284

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

285

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

286

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

yoshi-code-bot

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

[diff] [blame]

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

{

300

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

301

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

302

{

303

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

304

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

305

},

306

],

307

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

308

},

309

],

310

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

311

}</pre>

Sai Cheemalapati

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

315

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

Dan O'Meara

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

[diff] [blame]

316

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

317

318

Args:

319

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

320

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

321

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

322

body: object, The request body.

323

The object takes the form of:

324

325

{

Yoshi Automation Bot

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

[diff] [blame]

326

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

327

"A String",

328

],

329

}

Dan O'Meara

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

[diff] [blame]

330

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

331

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

332

x__xgafv: string, V1 error format.

333

Allowed values

334

1 - v1 error format

335

2 - v2 error format

Dan O'Meara

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

[diff] [blame]

336

337

Returns:

338

An object of the form:

339

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

340

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

341

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

342

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

343

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

344

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

345

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

346

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

Bu Sun Kim

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

[diff] [blame]

347

{

Yoshi Automation Bot

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

[diff] [blame]

348

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

349

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

350

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

Bu Sun Kim

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

[diff] [blame]

351

},

352

],

Yoshi Automation Bot

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

[diff] [blame]

353

},

354

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

355

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

356

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

357

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

358

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

359

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

yoshi-code-bot

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

[diff] [blame]

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

{

373

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

374

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

375

{

376

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

377

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

378

},

379

],

380

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

381

},

382

],

383

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

384

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

388

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

Bu Sun Kim

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

[diff] [blame]

389

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

390

391

Args:

392

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

393

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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]

394

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]

395

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

396

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

397

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]

398

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

399

x__xgafv: string, V1 error format.

400

Allowed values

401

1 - v1 error format

402

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

403

404

Returns:

405

An object of the form:

406

407

{

Yoshi Automation Bot

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

[diff] [blame]

408

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

409

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

410

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

411

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

412

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

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

[diff] [blame]

413

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

414

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

Anthonios Partheniou

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

[diff] [blame]

415

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

yoshi-code-bot

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

[diff] [blame]

416

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

417

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

Yoshi Automation Bot

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

[diff] [blame]

418

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

419

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

420

},

421

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

422

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

423

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

424

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

425

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

426

{ # An instance-attached disk resource.

427

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

428

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

429

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

430

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Yoshi Automation Bot

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

[diff] [blame]

431

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

432

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

433

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

434

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

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

[diff] [blame]

435

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

436

},

437

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

438

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

Yoshi Automation Bot

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

[diff] [blame]

439

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

440

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

Yoshi Automation Bot

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

[diff] [blame]

441

},

442

],

443

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

444

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Yoshi Automation Bot

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

[diff] [blame]

445

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

446

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

447

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

448

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

449

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Yoshi Automation Bot

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

[diff] [blame]

450

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

451

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

Yoshi Automation Bot

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

[diff] [blame]

452

},

453

],

454

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

455

"a_key": "A String",

456

},

457

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

458

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

459

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Yoshi Automation Bot

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

[diff] [blame]

460

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

461

"A String",

462

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

463

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

464

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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]

465

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

466

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

467

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

468

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

469

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

470

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

471

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Yoshi Automation Bot

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

[diff] [blame]

472

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

473

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

474

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

475

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

476

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

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

[diff] [blame]

477

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

478

},

Yoshi Automation Bot

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

[diff] [blame]

479

},

480

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

481

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

482

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

483

"A String",

484

],

485

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

486

"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

487

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

488

{

Bu Sun Kim

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

[diff] [blame]

489

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

490

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

Dan O'Meara

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

[diff] [blame]

491

},

Yoshi Automation Bot

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

[diff] [blame]

492

],

493

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

494

{

495

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

496

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

497

},

498

],

499

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

500

{

501

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

502

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

503

},

504

],

505

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

506

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

507

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

Dan O'Meara

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

[diff] [blame]

508

},

Sai Cheemalapati

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

[diff] [blame]

509

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

510

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Yoshi Automation Bot

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

[diff] [blame]

511

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

Bu Sun Kim

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

[diff] [blame]

512

},

Yoshi Automation Bot

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

[diff] [blame]

513

],

514

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

515

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

516

},

517

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

518

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

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

[diff] [blame]

519

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

520

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

521

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

522

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

523

},

524

],

525

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

526

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

527

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

528

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

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

[diff] [blame]

529

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

530

"a_key": "A String",

531

},

532

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

533

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

534

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

535

"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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

Yoshi Automation Bot

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

[diff] [blame]

536

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

537

"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. To see the latest fingerprint, make a get() request to retrieve the resource.

Yoshi Automation Bot

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

[diff] [blame]

538

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

539

{ # Metadata

Yoshi Automation Bot

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

[diff] [blame]

540

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

541

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

Bu Sun Kim

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

[diff] [blame]

542

},

543

],

Yoshi Automation Bot

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

[diff] [blame]

544

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

545

},

546

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

547

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

548

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

549

{ # A network interface resource attached to an instance.

550

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

551

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

yoshi-code-bot

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

[diff] [blame]

552

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

553

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

Yoshi Automation Bot

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

[diff] [blame]

554

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

555

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

556

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

557

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

Yoshi Automation Bot

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

[diff] [blame]

558

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

559

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

560

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

561

},

Bu Sun Kim

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

[diff] [blame]

562

],

Yoshi Automation Bot

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

[diff] [blame]

563

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

564

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

565

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

566

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

567

},

568

],

yoshi-code-bot

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

[diff] [blame]

569

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

yoshi-code-bot

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

[diff] [blame]

570

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

571

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

572

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

573

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

574

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

575

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

576

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

577

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

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

[diff] [blame]

578

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

579

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

580

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

581

},

582

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

583

"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. Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

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

[diff] [blame]

584

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

585

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

586

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

587

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Yoshi Automation Bot

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

[diff] [blame]

588

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

yoshi-code-bot

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

[diff] [blame]

589

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

590

"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. This field can be both set at instance creation and update network interface operations.

591

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

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

[diff] [blame]

592

},

Yoshi Automation Bot

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

[diff] [blame]

593

],

yoshi-code-bot

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

[diff] [blame]

594

"networkPerformanceConfig": {

595

"totalEgressBandwidthTier": "A String",

596

},

yoshi-code-bot

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

[diff] [blame]

597

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

598

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

Yoshi Automation Bot

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

[diff] [blame]

599

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

600

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

Yoshi Automation Bot

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

[diff] [blame]

601

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

602

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

603

"A String",

604

],

Yoshi Automation Bot

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

[diff] [blame]

605

},

606

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

607

"A String",

608

],

yoshi-code-bot

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

[diff] [blame]

609

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

yoshi-code-bot

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

[diff] [blame]

610

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

611

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

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

[diff] [blame]

612

"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-code-bot

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

[diff] [blame]

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

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

[diff] [blame]

626

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

627

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

628

},

629

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

630

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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.

Yoshi Automation Bot

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

[diff] [blame]

631

{ # A service account.

632

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

633

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

Bu Sun Kim

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

[diff] [blame]

634

"A String",

635

],

636

},

Sai Cheemalapati

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

[diff] [blame]

637

],

Yoshi Automation Bot

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

[diff] [blame]

638

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

639

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

640

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

641

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

642

},

643

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

644

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

645

},

646

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

647

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

648

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

649

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

650

},

651

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

652

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

653

},

654

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

yoshi-code-bot

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

[diff] [blame]

655

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

656

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

657

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

658

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

659

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

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

[diff] [blame]

660

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

661

},

662

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

663

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

Yoshi Automation Bot

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

[diff] [blame]

664

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

665

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

666

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

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

[diff] [blame]

667

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

"A String",

],

},

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

Bu Sun Kim

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

[diff] [blame]

672

},

673

],

Yoshi Automation Bot

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

[diff] [blame]

674

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

675

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

676

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

677

{

678

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

679

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

680

},

681

],

682

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

683

},

Bu Sun Kim

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

[diff] [blame]

684

},

Yoshi Automation Bot

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

[diff] [blame]

685

},

686

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

687

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

688

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

689

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

690

"A String",

691

],

692

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

693

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

694

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

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

[diff] [blame]

695

{

696

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

697

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

698

},

699

],

700

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

701

},

702

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

707

<pre>Retrieves the next page of results.

708

709

Args:

710

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

711

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

712

713

Returns:

Bu Sun Kim

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

[diff] [blame]

714

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

Sai Cheemalapati

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

[diff] [blame]

715

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

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

720

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

Sai Cheemalapati

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

[diff] [blame]

721

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

722

723

Args:

724

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

725

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

726

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

Dan O'Meara

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

[diff] [blame]

727

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

728

The object takes the form of:

729

730

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

731

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

732

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

733

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

734

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. 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]

735

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

736

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

737

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

738

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

739

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

740

},

Bu Sun Kim

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

[diff] [blame]

741

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

742

"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

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

[diff] [blame]

743

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

744

"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

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

[diff] [blame]

745

},

746

],

747

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

748

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. 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]

749

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

750

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

751

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

752

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

753

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Bu Sun Kim

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

[diff] [blame]

754

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

755

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

756

},

757

],

Bu Sun Kim

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

[diff] [blame]

758

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

759

"a_key": "A String",

760

},

Bu Sun Kim

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

[diff] [blame]

761

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

762

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

763

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Bu Sun Kim

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

[diff] [blame]

764

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

765

"A String",

Bu Sun Kim

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

[diff] [blame]

766

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

767

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

768

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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]

769

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

770

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

771

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

772

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

773

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

774

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

775

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

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

[diff] [blame]

776

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

Bu Sun Kim

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

[diff] [blame]

777

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

778

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

779

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

780

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

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

[diff] [blame]

781

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

782

},

Sai Cheemalapati

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

[diff] [blame]

783

},

Bu Sun Kim

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

[diff] [blame]

784

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

785

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

786

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

787

"A String",

788

],

789

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

790

"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

791

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

Dan O'Meara

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

[diff] [blame]

792

{

Bu Sun Kim

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

[diff] [blame]

793

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

794

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

Dan O'Meara

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

[diff] [blame]

795

},

796

],

Bu Sun Kim

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

[diff] [blame]

797

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

Dan O'Meara

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

[diff] [blame]

798

{

Bu Sun Kim

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

[diff] [blame]

799

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

800

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

Dan O'Meara

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

[diff] [blame]

801

},

802

],

Bu Sun Kim

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

[diff] [blame]

803

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

Dan O'Meara

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

[diff] [blame]

804

{

Bu Sun Kim

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

[diff] [blame]

805

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

806

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

Dan O'Meara

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

[diff] [blame]

807

},

808

],

Bu Sun Kim

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

[diff] [blame]

809

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

810

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

811

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

Dan O'Meara

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

[diff] [blame]

812

},

813

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

814

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 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]

815

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

Sai Cheemalapati

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

[diff] [blame]

816

}

817

Dmitry Frenkel

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

[diff] [blame]

818

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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

819

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

820

x__xgafv: string, V1 error format.

821

Allowed values

822

1 - v1 error format

823

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

824

825

Returns:

826

An object of the form:

827

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

828

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

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

[diff] [blame]

829

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

830

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

831

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

832

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

833

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

834

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

Bu Sun Kim

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

[diff] [blame]

835

{

Yoshi Automation Bot

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

[diff] [blame]

836

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

837

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

838

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

Bu Sun Kim

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

[diff] [blame]

839

},

840

],

Yoshi Automation Bot

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

[diff] [blame]

841

},

842

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

843

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

844

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

845

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

846

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

847

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

yoshi-code-bot

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

[diff] [blame]

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

{

861

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

862

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

yoshi-code-bot

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

[diff] [blame]

863

{

864

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

865

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

866

},

867

],

868

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

869

},

870

],

871

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

}</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

876

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

yoshi-code-bot

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

[diff] [blame]

877

<pre>Creates multiple instances. Count specifies the number of instances to create.

878

879

Args:

880

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

881

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

882

body: object, The request body.

883

The object takes the form of:

884

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

885

{ # A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests.

yoshi-code-bot

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

[diff] [blame]

886

"count": "A String", # The maximum number of instances to create.

887

"instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

888

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

889

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

Anthonios Partheniou

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

[diff] [blame]

890

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

yoshi-code-bot

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

[diff] [blame]

891

},

892

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

893

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

894

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

895

},

896

"description": "A String", # An optional text description for the instances that are created from these properties.

897

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

898

{ # An instance-attached disk resource.

899

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

900

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

901

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

902

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

yoshi-code-bot

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

[diff] [blame]

903

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

904

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

905

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

906

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

yoshi-code-bot

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

[diff] [blame]

907

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

908

},

909

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

910

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

yoshi-code-bot

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

[diff] [blame]

911

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

912

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

yoshi-code-bot

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

[diff] [blame]

913

},

914

],

915

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

916

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

yoshi-code-bot

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

[diff] [blame]

917

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

918

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

919

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

920

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

921

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

yoshi-code-bot

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

[diff] [blame]

922

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

923

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

yoshi-code-bot

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

[diff] [blame]

924

},

925

],

926

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

927

"a_key": "A String",

928

},

929

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

930

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

931

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

yoshi-code-bot

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

[diff] [blame]

932

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

933

"A String",

934

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

935

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

936

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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.

yoshi-code-bot

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

[diff] [blame]

937

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

938

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

939

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

940

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

yoshi-code-bot

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

[diff] [blame]

941

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

942

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

943

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

yoshi-code-bot

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

[diff] [blame]

944

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

945

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

946

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

947

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

948

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

yoshi-code-bot

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

[diff] [blame]

949

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

950

},

951

},

952

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

953

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

954

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

955

"A String",

956

],

957

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

958

"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

959

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

960

{

961

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

962

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

963

},

964

],

965

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

966

{

967

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

968

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

969

},

970

],

971

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

972

{

973

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

974

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

975

},

976

],

977

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

978

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

979

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

980

},

981

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

982

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

yoshi-code-bot

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

[diff] [blame]

983

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

984

},

985

],

986

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

987

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

988

},

989

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

990

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

991

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

992

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

993

},

994

],

995

"labels": { # Labels to apply to instances that are created from these properties.

996

"a_key": "A String",

997

},

998

"machineType": "A String", # The machine type to use for instances that are created from these properties.

999

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1000

"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. To see the latest fingerprint, make a get() request to retrieve the resource.

yoshi-code-bot

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

[diff] [blame]

1001

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1002

{ # Metadata

yoshi-code-bot

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

[diff] [blame]

1003

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

1004

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

1005

},

1006

],

1007

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

1008

},

1009

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

1010

"networkInterfaces": [ # An array of network access configurations for this interface.

1011

{ # A network interface resource attached to an instance.

1012

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

1013

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

yoshi-code-bot

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

[diff] [blame]

1014

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

1015

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

yoshi-code-bot

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

[diff] [blame]

1016

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

1017

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

1018

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1019

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

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

[diff] [blame]

1020

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

1021

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

1022

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

1023

},

1024

],

1025

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

1026

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

1027

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

1028

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

1029

},

1030

],

yoshi-code-bot

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

[diff] [blame]

1031

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

yoshi-code-bot

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

[diff] [blame]

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1039

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

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

[diff] [blame]

1040

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

1041

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

1042

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

1043

},

1044

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1045

"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. Valid only if stackType is IPV4_IPV6.

yoshi-code-bot

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

[diff] [blame]

1046

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

1047

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

1048

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1049

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

yoshi-code-bot

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

[diff] [blame]

1050

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

1051

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1052

"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. This field can be both set at instance creation and update network interface operations.

1053

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

yoshi-code-bot

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

[diff] [blame]

1054

},

1055

],

1056

"networkPerformanceConfig": {

1057

"totalEgressBandwidthTier": "A String",

1058

},

1059

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1060

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

yoshi-code-bot

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

[diff] [blame]

1061

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1062

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

yoshi-code-bot

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

[diff] [blame]

1063

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

1064

"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-code-bot

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

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

1069

"A String",

1070

],

yoshi-code-bot

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

[diff] [blame]

1071

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Specifies the scheduling options for the instances that are created from these properties.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1072

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

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

[diff] [blame]

1073

"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-code-bot

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

[diff] [blame]

1074

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

1075

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

1076

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

yoshi-code-bot

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

[diff] [blame]

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1088

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

1089

},

1090

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

1091

{ # A service account.

1092

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

1093

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

"A String",

],

},

],

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

1099

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

1100

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

1101

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

1102

},

1103

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1104

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

1105

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

1106

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

1107

},

1108

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1109

"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. To see the latest fingerprint, make get() request to the instance.

yoshi-code-bot

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

[diff] [blame]

1110

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

1115

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

1116

"locations": { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

yoshi-code-bot

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

[diff] [blame]

1117

"a_key": {

yoshi-code-bot

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

[diff] [blame]

1118

"preference": "A String", # Preference for a given location: ALLOW or DENY.

yoshi-code-bot

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

[diff] [blame]

1119

},

1120

},

1121

},

Anthonios Partheniou

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

[diff] [blame]

1122

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

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1123

"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 must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers 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-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.

yoshi-code-bot

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

[diff] [blame]

1124

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

1125

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

1126

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

1127

},

1128

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1129

"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. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional.

yoshi-code-bot

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

[diff] [blame]

1130

}

1131

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1132

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1133

x__xgafv: string, V1 error format.

1134

Allowed values

1135

1 - v1 error format

1136

2 - v2 error format

yoshi-code-bot

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

[diff] [blame]

1137

1138

Returns:

1139

An object of the form:

1140

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1141

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

yoshi-code-bot

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

[diff] [blame]

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

{

1149

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

1150

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

1151

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1166

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1167

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1168

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1169

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1170

"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.

1171

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1172

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1173

{

1174

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1175

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1176

{

1177

"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).

1178

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1179

},

1180

],

1181

"message": "A String", # [Output Only] A human-readable description of the warning code.

1182

},

1183

],

1184

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1185

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1189

<code class="details" id="close">close()</code>

1190

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1194

<code class="details" id="delete">delete(project, zone, instance, requestId=None, x__xgafv=None)</code>

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1195

<pre>Deletes the specified Instance resource. For more information, see Deleting an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1196

1197

Args:

1198

project: string, Project ID for this request. (required)

1199

zone: string, The name of the zone for this request. (required)

1200

instance: string, Name of the instance resource to delete. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1201

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1202

x__xgafv: string, V1 error format.

1203

Allowed values

1204

1 - v1 error format

1205

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1206

1207

Returns:

1208

An object of the form:

1209

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1210

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1211

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1212

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1213

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1214

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1215

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1216

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1217

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1218

"code": "A String", # [Output Only] The error type identifier for this error.

1219

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1220

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1221

},

1222

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1223

},

1224

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1225

"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.

1226

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1227

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1228

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1229

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1230

"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]

1231

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1232

"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.

1233

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1234

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1235

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1236

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1237

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1238

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1239

"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.

1240

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1241

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1242

{

1243

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1244

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1245

{

1246

"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).

1247

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1248

},

1249

],

1250

"message": "A String", # [Output Only] A human-readable description of the warning code.

1251

},

1252

],

1253

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1254

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1258

<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1259

<pre>Deletes an access config from an instance's network interface.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1260

1261

Args:

1262

project: string, Project ID for this request. (required)

1263

zone: string, The name of the zone for this request. (required)

1264

instance: string, The instance name for this request. (required)

1265

accessConfig: string, The name of the access config to delete. (required)

1266

networkInterface: string, The name of the network interface. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1267

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1268

x__xgafv: string, V1 error format.

1269

Allowed values

1270

1 - v1 error format

1271

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1272

1273

Returns:

1274

An object of the form:

1275

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1276

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1277

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1278

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1279

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1280

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1281

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1282

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1284

"code": "A String", # [Output Only] The error type identifier for this error.

1285

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1286

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1287

},

1288

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1289

},

1290

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1291

"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.

1292

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1293

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1294

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1295

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1296

"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]

1297

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1298

"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.

1299

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1300

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1301

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1302

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1303

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1304

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1305

"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.

1306

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1307

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1308

{

1309

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1310

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1311

{

1312

"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).

1313

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1314

},

1315

],

1316

"message": "A String", # [Output Only] A human-readable description of the warning code.

1317

},

1318

],

1319

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1320

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1324

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1325

<pre>Detaches a disk from an instance.

1326

1327

Args:

1328

project: string, Project ID for this request. (required)

1329

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1330

instance: string, Instance name for this request. (required)

1331

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)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1332

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1333

x__xgafv: string, V1 error format.

1334

Allowed values

1335

1 - v1 error format

1336

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1337

1338

Returns:

1339

An object of the form:

1340

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1341

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1342

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1343

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1344

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1345

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1346

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1347

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1348

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1349

"code": "A String", # [Output Only] The error type identifier for this error.

1350

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1351

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1352

},

1353

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1354

},

1355

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1356

"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.

1357

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1358

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1359

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1360

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1361

"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]

1362

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1363

"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.

1364

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1365

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1366

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1367

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1368

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1369

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1370

"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.

1371

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1372

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1373

{

1374

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1375

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1376

{

1377

"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).

1378

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1379

},

1380

],

1381

"message": "A String", # [Output Only] A human-readable description of the warning code.

1382

},

1383

],

1384

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1385

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1389

<code class="details" id="get">get(project, zone, instance, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1390

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1391

1392

Args:

1393

project: string, Project ID for this request. (required)

1394

zone: string, The name of the zone for this request. (required)

1395

instance: string, Name of the instance resource to return. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1396

x__xgafv: string, V1 error format.

1397

Allowed values

1398

1 - v1 error format

1399

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1400

1401

Returns:

1402

An object of the form:

1403

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1404

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1405

"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.

1406

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1407

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1408

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1409

"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 .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1410

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1411

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1412

},

1413

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1414

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1415

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1416

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1417

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

1418

{ # An instance-attached disk resource.

1419

"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).

1420

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1421

"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. 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.

1422

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1423

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1424

"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.

1425

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1426

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1427

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1428

},

1429

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1430

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1431

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1432

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1433

},

1434

],

1435

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1436

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1437

"description": "A String", # An optional description. Provide this property when creating the disk.

1438

"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.

1439

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1440

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1441

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1442

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1443

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1444

},

1445

],

1446

"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.

1447

"a_key": "A String",

1448

},

1449

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1450

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1451

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1452

"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.

1453

"A String",

1454

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1455

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

1456

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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]

1457

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1458

"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.

1459

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1460

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1461

"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]

1462

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1463

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1464

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1465

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1466

"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.

1467

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1468

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1469

"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]

1470

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1471

},

1472

"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.

1473

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1474

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1475

"A String",

1476

],

1477

"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.

1478

"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

1479

"dbs": [ # The Key Database (db).

1480

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1481

"content": "A String", # The raw content in the secure keys file.

1482

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1483

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1484

],

1485

"dbxs": [ # The forbidden key database (dbx).

1486

{

1487

"content": "A String", # The raw content in the secure keys file.

1488

"fileType": "A String", # The file type of source file.

1489

},

1490

],

1491

"keks": [ # The Key Exchange Key (KEK).

1492

{

1493

"content": "A String", # The raw content in the secure keys file.

1494

"fileType": "A String", # The file type of source file.

1495

},

1496

],

1497

"pk": { # The Platform Key (PK).

1498

"content": "A String", # The raw content in the secure keys file.

1499

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1500

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1501

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1502

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1503

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1504

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1505

],

1506

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1507

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1508

},

1509

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1510

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1511

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1512

{ # A specification of the type and number of accelerator cards attached to the instance.

1513

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1514

"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.

1515

},

1516

],

1517

"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.

1518

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1519

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1520

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1521

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1522

"a_key": "A String",

1523

},

1524

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1525

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1526

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1527

"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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1528

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1529

"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. To see the latest fingerprint, make a get() request to retrieve the resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1530

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1531

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1532

"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.

1533

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1534

},

1535

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1536

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1537

},

1538

"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".

1539

"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.

1540

"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.

1541

{ # A network interface resource attached to an instance.

1542

"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.

1543

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1544

"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.

1545

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1546

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1547

"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.

1548

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1549

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1550

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1551

"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.

1552

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1553

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1554

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1555

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1556

{ # An alias IP range attached to an instance's network interface.

1557

"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).

1558

"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.

1559

},

1560

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1561

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1562

"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.

1563

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1564

"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.

1565

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1566

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1567

"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.

1568

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1569

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1570

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1571

"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.

1572

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1573

},

1574

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1575

"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. Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1576

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1577

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1578

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1579

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1580

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1581

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1582

"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. This field can be both set at instance creation and update network interface operations.

1583

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1584

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1585

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1586

"networkPerformanceConfig": {

1587

"totalEgressBandwidthTier": "A String",

1588

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1589

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1590

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1591

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1592

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1593

"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]

1594

"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]

1595

"A String",

1596

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1597

},

1598

"resourcePolicies": [ # Resource policies applied to this instance.

1599

"A String",

1600

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1601

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1602

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1603

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1604

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1605

"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]

1606

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

1607

"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]

1608

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1609

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1610

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1611

"key": "A String", # Corresponds to the label key of Node resource.

1612

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1613

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1618

"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.

1619

"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.

1620

},

1621

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1622

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1623

{ # A service account.

1624

"email": "A String", # Email address of the service account.

1625

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1626

"A String",

1627

],

1628

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1629

],

1630

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1631

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1632

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1633

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1634

},

1635

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1636

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1637

},

1638

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

1639

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1640

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1641

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1642

},

1643

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

1644

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1645

},

1646

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1647

"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]

1648

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1649

"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.

1650

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1651

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1652

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1653

},

1654

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1655

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1656

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1657

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1658

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1659

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1664

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1668

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1669

<pre>Returns effective firewalls applied to an interface of the instance.

1670

1671

Args:

1672

project: string, Project ID for this request. (required)

1673

zone: string, The name of the zone for this request. (required)

1674

instance: string, Name of the instance scoping this request. (required)

1675

networkInterface: string, The name of the network interface to get the effective firewalls. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1676

x__xgafv: string, V1 error format.

1677

Allowed values

1678

1 - v1 error format

1679

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1680

1681

Returns:

1682

An object of the form:

1683

1684

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1685

"firewallPolicys": [ # Effective firewalls from firewall policies.

1686

{

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1687

"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]

1688

"name": "A String", # [Output Only] The name of the firewall policy.

1689

"rules": [ # The rules that apply to the network.

1690

{ # 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).

1691

"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]

1692

"description": "A String", # An optional description for this resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1693

"direction": "A String", # The direction in which this rule applies.

1694

"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.

1695

"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.

1696

"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]

1697

"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]

1698

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1699

"A String",

1700

],

1701

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1702

{

1703

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1704

"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1710

"A String",

1711

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1712

},

1713

"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.

1714

"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]

1715

"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]

1716

"A String",

1717

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1718

"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]

1723

"shortName": "A String", # [Output Only] The short name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1724

"type": "A String", # [Output Only] The type of the firewall policy.

1725

},

1726

],

1727

"firewalls": [ # Effective firewalls on the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1728

{ # Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1729

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

1730

{

1731

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1732

"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1738

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

1739

{

1740

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1741

"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

1747

"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.

1748

"A String",

1749

],

1750

"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.

1751

"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.

1752

"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.

1753

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1754

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

1755

"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.

1756

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

1757

"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.

1758

},

1759

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1760

"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: global/networks/default 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: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1761

"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`.

1762

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1763

"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.

1764

"A String",

1765

],

1766

"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.

1767

"A String",

1768

],

1769

"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.

1770

"A String",

1771

],

1772

"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.

1773

"A String",

1774

],

1775

"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.

1781

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

1782

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

1783

"rules": [ # The rules that apply to the network.

1784

{ # 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]

1785

"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]

1786

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1787

"direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1788

"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. This field may only be specified when the versioned_expr is set to FIREWALL.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1789

"headerAction": { # Optional, additional actions that are performed on headers.

1790

"requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.

1791

{

1792

"headerName": "A String", # The name of the header to set.

1793

"headerValue": "A String", # The value to set the named header to.

1794

},

1795

],

1796

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1797

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

1798

"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.

1799

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1800

"destIpRanges": [ # CIDR IP address range. 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]

1801

"A String",

1802

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1803

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. 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]

1804

{

1805

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1806

"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. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 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]

1811

"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]

1812

"A String",

1813

],

1814

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1815

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1816

"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.

1817

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1818

"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.

1819

"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.

1820

},

1821

"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]

1822

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1823

"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]

1824

"priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1825

"redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions.

1826

"target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

1827

"type": "A String", # Type of the redirect action.

1828

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1829

"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.

1830

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1831

"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. This field may only be specified when versioned_expr is set to FIREWALL.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1832

"A String",

1833

],

1834

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

1835

"A String",

1836

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1837

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

],

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1845

<code class="details" id="getGuestAttributes">getGuestAttributes(project, zone, instance, queryPath=None, variableKey=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1846

<pre>Returns the specified guest attributes entry.

1847

1848

Args:

1849

project: string, Project ID for this request. (required)

1850

zone: string, The name of the zone for this request. (required)

1851

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1852

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1853

variableKey: string, Specifies the key for the guest attributes entry.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1854

x__xgafv: string, V1 error format.

1855

Allowed values

1856

1 - v1 error format

1857

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1858

1859

Returns:

1860

An object of the form:

1861

1862

{ # A guest attributes entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1863

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1864

"queryPath": "A String", # The path to be queried. This can be the default namespace ('') or a nested namespace ('\/') or a specified key ('\/\').

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1865

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

1866

"items": [

1867

{ # A guest attributes namespace/key/value entry.

1868

"key": "A String", # Key for the guest attribute entry.

1869

"namespace": "A String", # Namespace for the guest attribute entry.

1870

"value": "A String", # Value for the guest attribute entry.

},

],

},

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1875

"variableKey": "A String", # The key to search for.

1876

"variableValue": "A String", # [Output Only] The value found for the requested key.

1877

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1881

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1882

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

1883

1884

Args:

1885

project: string, Project ID for this request. (required)

1886

zone: string, The name of the zone for this request. (required)

1887

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1888

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1889

x__xgafv: string, V1 error format.

1890

Allowed values

1891

1 - v1 error format

1892

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1893

1894

Returns:

1895

An object of the form:

1896

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1897

{ # 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. 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 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1898

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1899

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1900

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1901

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

1902

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1903

"A String",

1904

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1905

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1906

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1907

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1908

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1909

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1910

"A String",

1911

],

1912

"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.

1913

},

1914

],

1915

"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.

1916

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1917

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

1918

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. 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]

1919

"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.

1920

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1921

"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.

1922

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1923

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1924

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1925

"A String",

1926

],

1927

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1928

},

1929

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1930

"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. **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.

1931

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

1932

"rules": [ # This is deprecated and has no effect. Do not use.

1933

{ # This is deprecated and has no effect. Do not use.

1934

"action": "A String", # This is deprecated and has no effect. Do not use.

1935

"conditions": [ # This is deprecated and has no effect. Do not use.

1936

{ # This is deprecated and has no effect. Do not use.

1937

"iam": "A String", # This is deprecated and has no effect. Do not use.

1938

"op": "A String", # This is deprecated and has no effect. Do not use.

1939

"svc": "A String", # This is deprecated and has no effect. Do not use.

1940

"sys": "A String", # This is deprecated and has no effect. Do not use.

1941

"values": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1946

"description": "A String", # This is deprecated and has no effect. Do not use.

1947

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1948

"A String",

1949

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1950

"logConfigs": [ # This is deprecated and has no effect. Do not use.

1951

{ # This is deprecated and has no effect. Do not use.

1952

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1953

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1954

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1955

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1956

"logName": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1957

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1958

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1959

"customFields": [ # This is deprecated and has no effect. Do not use.

1960

{ # This is deprecated and has no effect. Do not use.

1961

"name": "A String", # This is deprecated and has no effect. Do not use.

1962

"value": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1963

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1964

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1965

"field": "A String", # This is deprecated and has no effect. Do not use.

1966

"metric": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1967

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1968

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1969

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1970

},

1971

},

1972

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1973

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1974

"A String",

1975

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1976

"permissions": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1981

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. 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]

1982

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1986

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1987

<pre>Returns the screenshot from the specified instance.

1988

1989

Args:

1990

project: string, Project ID for this request. (required)

1991

zone: string, The name of the zone for this request. (required)

1992

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1993

x__xgafv: string, V1 error format.

1994

Allowed values

1995

1 - v1 error format

1996

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1997

1998

Returns:

1999

An object of the form:

2000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2001

{ # An instance's screenshot.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2002

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

2003

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

2004

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2008

<code class="details" id="getSerialPortOutput">getSerialPortOutput(project, zone, instance, port=None, start=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2009

<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]

2010

2011

Args:

2012

project: string, Project ID for this request. (required)

2013

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2014

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2015

port: integer, Specifies which COM or serial port to retrieve data from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2016

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`. 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. 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.

2017

x__xgafv: string, V1 error format.

2018

Allowed values

2019

1 - v1 error format

2020

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2021

2022

Returns:

2023

An object of the form:

2024

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2025

{ # An instance serial console output.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2026

"contents": "A String", # [Output Only] The contents of the console output.

2027

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

2028

"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.

2029

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2030

"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.

2031

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2035

<code class="details" id="getShieldedInstanceIdentity">getShieldedInstanceIdentity(project, zone, instance, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2036

<pre>Returns the Shielded Instance Identity of an instance

2037

2038

Args:

2039

project: string, Project ID for this request. (required)

2040

zone: string, The name of the zone for this request. (required)

2041

instance: string, Name or id of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2042

x__xgafv: string, V1 error format.

2043

Allowed values

2044

1 - v1 error format

2045

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2046

2047

Returns:

2048

An object of the form:

2049

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2050

{ # A Shielded Instance Identity.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2051

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2052

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2053

"ekPub": "A String", # A PEM-encoded public key.

2054

},

2055

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

2056

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2057

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2058

"ekPub": "A String", # A PEM-encoded public key.

2059

},

2060

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2064

<code class="details" id="getShieldedVmIdentity">getShieldedVmIdentity(project, zone, instance, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2065

<pre>Returns the Shielded VM Identity of an instance

2066

2067

Args:

2068

project: string, Project ID for this request. (required)

2069

zone: string, The name of the zone for this request. (required)

2070

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2071

x__xgafv: string, V1 error format.

2072

Allowed values

2073

1 - v1 error format

2074

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2075

2076

Returns:

2077

An object of the form:

2078

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2079

{ # A Shielded VM Identity.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2080

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

2081

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2082

"ekPub": "A String", # A PEM-encoded public key.

2083

},

2084

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

2085

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

2086

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2087

"ekPub": "A String", # A PEM-encoded public key.

2088

},

2089

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2093

<code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, sourceMachineImage=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2094

<pre>Creates an instance resource in the specified project using the data included in the request.

2095

2096

Args:

2097

project: string, Project ID for this request. (required)

2098

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2099

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2100

The object takes the form of:

2101

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2102

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2103

"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.

2104

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2105

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2106

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2107

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2108

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2109

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2110

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2111

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2112

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2113

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2114

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2115

"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]

2116

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2117

"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).

2118

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2119

"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. 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.

2120

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. 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]

2121

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2122

"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.

2123

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2124

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2125

"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]

2126

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2127

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2128

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

2129

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2130

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

2131

},

2132

],

2133

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2134

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. 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]

2135

"description": "A String", # An optional description. Provide this property when creating the disk.

2136

"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.

2137

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2138

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2139

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2140

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2141

"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]

2142

},

2143

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

"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.

2145

"a_key": "A String",

2146

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2147

"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]

2148

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2149

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2150

"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.

2151

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2152

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2153

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

2154

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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]

2155

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2156

"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.

2157

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2158

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2159

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2160

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2161

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2162

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2163

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2164

"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.

2165

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2166

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2167

"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]

2168

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2169

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2170

"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.

2171

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2172

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2173

"A String",

2174

],

2175

"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.

2176

"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

2177

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2178

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2179

"content": "A String", # The raw content in the secure keys file.

2180

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2181

},

2182

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2183

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2184

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2185

"content": "A String", # The raw content in the secure keys file.

2186

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2187

},

2188

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2189

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2190

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2191

"content": "A String", # The raw content in the secure keys file.

2192

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2193

},

2194

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2195

"pk": { # The Platform Key (PK).

2196

"content": "A String", # The raw content in the secure keys file.

2197

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2198

},

2199

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2200

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 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]

2201

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2202

},

2203

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2204

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2205

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2206

},

2207

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2208

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2209

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2210

{ # A specification of the type and number of accelerator cards attached to the instance.

2211

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2212

"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.

2213

},

2214

],

2215

"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.

2216

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2217

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2218

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2219

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2220

"a_key": "A String",

2221

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2222

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2223

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2224

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2225

"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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2226

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2227

"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. 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]

2228

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2229

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2230

"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.

2231

"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).

2232

},

2233

],

2234

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2235

},

2236

"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".

2237

"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.

2238

"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.

2239

{ # A network interface resource attached to an instance.

2240

"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.

2241

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2242

"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.

2243

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2244

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2245

"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.

2246

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2247

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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]

2248

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2249

"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.

2250

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2251

},

2252

],

2253

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2254

{ # An alias IP range attached to an instance's network interface.

2255

"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).

2256

"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.

2257

},

2258

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2259

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2260

"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.

2261

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2262

"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.

2263

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2264

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2265

"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.

2266

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2267

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2268

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2269

"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.

2270

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2271

},

2272

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2273

"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. Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2274

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2275

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2276

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2277

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2278

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2279

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2280

"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. This field can be both set at instance creation and update network interface operations.

2281

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2282

},

2283

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2284

"networkPerformanceConfig": {

2285

"totalEgressBandwidthTier": "A String",

2286

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2287

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2288

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2289

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2290

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2291

"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]

2292

"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.

2297

"A String",

2298

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2299

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2300

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2301

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2302

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2303

"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]

2304

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2305

"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]

2306

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2307

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2308

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2309

"key": "A String", # Corresponds to the label key of Node resource.

2310

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2311

"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]

2317

"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]

2318

},

2319

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2320

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2321

{ # A service account.

2322

"email": "A String", # Email address of the service account.

2323

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2329

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2330

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2331

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2332

},

2333

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2334

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2335

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2336

"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]

2337

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2338

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2339

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2340

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2341

"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]

2342

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2343

},

2344

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2345

"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]

2346

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2347

"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.

2348

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2349

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2350

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2351

},

2352

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2353

"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]

2354

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2355

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2356

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2357

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2362

}

2363

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2364

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

2365

sourceInstanceTemplate: string, Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate

2366

sourceMachineImage: string, Specifies the machine image to use to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to a machine image: - https://www.googleapis.com/compute/v1/projects/project/global/global /machineImages/machineImage - projects/project/global/global/machineImages/machineImage - global/machineImages/machineImage

2367

x__xgafv: string, V1 error format.

2368

Allowed values

2369

1 - v1 error format

2370

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2371

2372

Returns:

2373

An object of the form:

2374

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2375

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2376

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2377

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2378

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2379

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2380

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2381

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2382

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2383

"code": "A String", # [Output Only] The error type identifier for this error.

2384

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2385

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2386

},

2387

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2388

},

2389

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2390

"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.

2391

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2392

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2393

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2394

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2395

"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]

2396

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2397

"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.

2398

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2399

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2400

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2401

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2402

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2403

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2404

"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.

2405

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2406

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2407

{

2408

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2409

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2410

{

2411

"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).

2412

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2413

},

2414

],

2415

"message": "A String", # [Output Only] A human-readable description of the warning code.

2416

},

2417

],

2418

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2419

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2423

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2424

<pre>Retrieves the list of instances contained within the specified zone.

2425

2426

Args:

2427

project: string, Project ID for this request. (required)

2428

zone: string, The name of the zone for this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2429

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2430

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`)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2431

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2432

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]

2433

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2434

x__xgafv: string, V1 error format.

2435

Allowed values

2436

1 - v1 error format

2437

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2438

2439

Returns:

2440

An object of the form:

2441

2442

{ # Contains a list of instances.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2443

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2444

"items": [ # A list of Instance resources.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2445

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2446

"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.

2447

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2448

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2449

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2450

"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 .

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2451

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2452

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2453

},

2454

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2455

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2456

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2457

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2458

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

2459

{ # An instance-attached disk resource.

2460

"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).

2461

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2462

"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. 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.

2463

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2464

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2465

"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.

2466

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2467

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2468

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2469

},

2470

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2471

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2472

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2473

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2474

},

2475

],

2476

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2477

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2478

"description": "A String", # An optional description. Provide this property when creating the disk.

2479

"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.

2480

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2481

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2482

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2483

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2484

"type": "A String", # The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2485

},

2486

],

2487

"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.

2488

"a_key": "A String",

2489

},

2490

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

2491

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2492

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2493

"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.

2494

"A String",

2495

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2496

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

2497

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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]

2498

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2499

"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.

2500

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2501

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2502

"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]

2503

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2504

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2505

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

2506

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2507

"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.

2508

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2509

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2510

"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]

2511

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2512

},

2513

"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.

2514

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2515

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2516

"A String",

2517

],

2518

"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.

2519

"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

2520

"dbs": [ # The Key Database (db).

2521

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2522

"content": "A String", # The raw content in the secure keys file.

2523

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2524

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2525

],

2526

"dbxs": [ # The forbidden key database (dbx).

2527

{

2528

"content": "A String", # The raw content in the secure keys file.

2529

"fileType": "A String", # The file type of source file.

2530

},

2531

],

2532

"keks": [ # The Key Exchange Key (KEK).

2533

{

2534

"content": "A String", # The raw content in the secure keys file.

2535

"fileType": "A String", # The file type of source file.

2536

},

2537

],

2538

"pk": { # The Platform Key (PK).

2539

"content": "A String", # The raw content in the secure keys file.

2540

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2541

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2542

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2543

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2544

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2545

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2546

],

2547

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2552

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2553

{ # A specification of the type and number of accelerator cards attached to the instance.

2554

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2555

"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.

2556

},

2557

],

2558

"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.

2559

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2560

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2561

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2562

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2563

"a_key": "A String",

2564

},

2565

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2566

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2567

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2568

"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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2569

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2570

"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. To see the latest fingerprint, make a get() request to retrieve the resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2571

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2572

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2573

"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.

2574

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2575

},

2576

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2577

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2578

},

2579

"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".

2580

"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.

2581

"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.

2582

{ # A network interface resource attached to an instance.

2583

"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.

2584

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2585

"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.

2586

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2587

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2588

"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.

2589

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2590

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2591

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2592

"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.

2593

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2594

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2595

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2596

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2597

{ # An alias IP range attached to an instance's network interface.

2598

"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).

2599

"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.

2600

},

2601

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2602

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2603

"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.

2604

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2605

"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.

2606

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2607

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2608

"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.

2609

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2610

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2611

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2612

"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.

2613

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2614

},

2615

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2616

"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. Valid only if stackType is IPV4_IPV6.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2617

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2618

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2619

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2620

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2621

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2622

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2623

"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. This field can be both set at instance creation and update network interface operations.

2624

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2625

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2626

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2627

"networkPerformanceConfig": {

2628

"totalEgressBandwidthTier": "A String",

2629

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2630

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2631

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2632

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2633

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2634

"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]

2635

"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]

2636

"A String",

2637

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2638

},

2639

"resourcePolicies": [ # Resource policies applied to this instance.

2640

"A String",

2641

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2642

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2643

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2644

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2645

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2646

"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]

2647

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2648

"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]

2649

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2650

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2651

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2652

"key": "A String", # Corresponds to the label key of Node resource.

2653

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2654

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2659

"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.

2660

"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.

2661

},

2662

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2663

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2664

{ # A service account.

2665

"email": "A String", # Email address of the service account.

2666

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2667

"A String",

2668

],

2669

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2670

],

2671

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2672

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2673

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2674

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2675

},

2676

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2677

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2678

},

2679

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

2680

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2681

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2682

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2683

},

2684

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

2685

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2686

},

2687

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2688

"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]

2689

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2690

"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.

2691

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2692

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2693

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2694

},

2695

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2696

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2697

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2698

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2699

"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. To see the latest fingerprint, make get() request to the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2700

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2705

},

2706

],

2707

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

2708

"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.

2709

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2710

"warning": { # [Output Only] Informational warning message.

2711

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2712

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2713

{

2714

"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).

2715

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2716

},

2717

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2718

"message": "A String", # [Output Only] A human-readable description of the warning code.

2719

},

2720

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2724

<code class="details" id="listReferrers">listReferrers(project, zone, instance, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2725

<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]

2726

2727

Args:

2728

project: string, Project ID for this request. (required)

2729

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2730

instance: string, Name of the target instance scoping this request, or '-' if the request should span over all instances in the container. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2731

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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]

2732

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`)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2733

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2734

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]

2735

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2736

x__xgafv: string, V1 error format.

2737

Allowed values

2738

1 - v1 error format

2739

2 - v2 error format

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2740

2741

Returns:

2742

An object of the form:

2743

2744

{ # Contains a list of instance referrers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2745

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2746

"items": [ # A list of Reference resources.

2747

{ # Represents a reference to a resource.

2748

"kind": "compute#reference", # [Output Only] Type of the resource. Always compute#reference for references.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2749

"referenceType": "A String", # A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2750

"referrer": "A String", # URL of the resource which refers to the target.

2751

"target": "A String", # URL of the resource to which this reference points.

2752

},

2753

],

2754

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

2755

"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.

2756

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2757

"warning": { # [Output Only] Informational warning message.

2758

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2759

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2760

{

2761

"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).

2762

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2763

},

2764

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2765

"message": "A String", # [Output Only] A human-readable description of the warning code.

2766

},

2767

}</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>

2772

<pre>Retrieves the next page of results.

2773

2774

Args:

2775

previous_request: The request for the previous page. (required)

2776

previous_response: The response from the request for the previous page. (required)

2777

2778

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2779

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

2780

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]

2785

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2786

<pre>Retrieves the next page of results.

2787

2788

Args:

2789

previous_request: The request for the previous page. (required)

2790

previous_response: The response from the request for the previous page. (required)

2791

2792

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2793

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2794

page. Returns None if there are no more items in the collection.

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2799

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2800

<pre>Removes resource policies from an instance.

2801

2802

Args:

2803

project: string, Project ID for this request. (required)

2804

zone: string, The name of the zone for this request. (required)

2805

instance: string, The instance name for this request. (required)

2806

body: object, The request body.

2807

The object takes the form of:

2808

2809

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2810

"resourcePolicies": [ # Resource policies to be removed from this instance.

2811

"A String",

2812

],

2813

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2814

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2815

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

2816

x__xgafv: string, V1 error format.

2817

Allowed values

2818

1 - v1 error format

2819

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2820

2821

Returns:

2822

An object of the form:

2823

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2824

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2825

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2826

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2827

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2828

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2829

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2830

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2831

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2832

"code": "A String", # [Output Only] The error type identifier for this error.

2833

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2834

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2835

},

2836

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2837

},

2838

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2839

"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.

2840

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2841

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2842

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2843

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2844

"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]

2845

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2846

"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.

2847

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2848

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2849

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2850

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2851

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2852

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2853

"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.

2854

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2855

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2856

{

2857

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2858

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2859

{

2860

"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).

2861

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2862

},

2863

],

2864

"message": "A String", # [Output Only] A human-readable description of the warning code.

2865

},

2866

],

2867

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2868

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2872

<code class="details" id="reset">reset(project, zone, instance, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2873

<pre>Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2874

2875

Args:

2876

project: string, Project ID for this request. (required)

2877

zone: string, The name of the zone for this request. (required)

2878

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2879

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

2880

x__xgafv: string, V1 error format.

2881

Allowed values

2882

1 - v1 error format

2883

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2884

2885

Returns:

2886

An object of the form:

2887

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2888

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2889

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2890

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2891

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2892

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2893

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2894

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2895

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2896

"code": "A String", # [Output Only] The error type identifier for this error.

2897

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2898

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2899

},

2900

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2901

},

2902

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2903

"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.

2904

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2905

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2906

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2907

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2908

"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]

2909

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2910

"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.

2911

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2912

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2913

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2914

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2915

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2916

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2917

"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.

2918

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2919

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2920

{

2921

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2922

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2923

{

2924

"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).

2925

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2926

},

2927

],

2928

"message": "A String", # [Output Only] A human-readable description of the warning code.

2929

},

2930

],

2931

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2932

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2936

<code class="details" id="resume">resume(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2937

<pre>Resumes an instance that was suspended using the instances().suspend method.

2938

2939

Args:

2940

project: string, Project ID for this request. (required)

2941

zone: string, The name of the zone for this request. (required)

2942

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2943

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2944

The object takes the form of:

2945

2946

{

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2947

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2948

{

2949

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

2950

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2951

"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.

2952

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2953

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2954

"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]

2955

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2956

"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]

2957

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2958

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2959

"instanceEncryptionKey": { # Decrypts data associated with an instance that is protected with a customer-supplied encryption key. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2960

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2961

"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.

2962

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2963

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2964

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2965

},

2966

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2967

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2968

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

2969

x__xgafv: string, V1 error format.

2970

Allowed values

2971

1 - v1 error format

2972

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2973

2974

Returns:

2975

An object of the form:

2976

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2977

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2978

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2979

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2980

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2981

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2982

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2983

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2984

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2985

"code": "A String", # [Output Only] The error type identifier for this error.

2986

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2987

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2988

},

2989

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2990

},

2991

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2992

"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.

2993

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2994

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2995

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2996

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2997

"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]

2998

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2999

"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.

3000

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3001

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3002

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3003

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3004

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3005

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3006

"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.

3007

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3008

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3009

{

3010

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3011

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3012

{

3013

"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).

3014

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3015

},

3016

],

3017

"message": "A String", # [Output Only] A human-readable description of the warning code.

3018

},

3019

],

3020

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3021

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3025

<code class="details" id="setDeletionProtection">setDeletionProtection(project, zone, resource, deletionProtection=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3026

<pre>Sets deletion protection on the instance.

3027

3028

Args:

3029

project: string, Project ID for this request. (required)

3030

zone: string, The name of the zone for this request. (required)

3031

resource: string, Name or id of the resource for this request. (required)

3032

deletionProtection: boolean, Whether the resource should be protected against deletion.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3033

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3034

x__xgafv: string, V1 error format.

3035

Allowed values

3036

1 - v1 error format

3037

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3038

3039

Returns:

3040

An object of the form:

3041

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3042

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3043

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3044

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3045

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3046

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3047

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3048

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3049

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3050

"code": "A String", # [Output Only] The error type identifier for this error.

3051

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3052

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3053

},

3054

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3055

},

3056

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3057

"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.

3058

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3059

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3060

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3061

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3062

"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]

3063

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3064

"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.

3065

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3066

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3067

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3068

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3069

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3070

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3071

"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.

3072

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3073

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3074

{

3075

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3076

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3077

{

3078

"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).

3079

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3080

},

3081

],

3082

"message": "A String", # [Output Only] A human-readable description of the warning code.

3083

},

3084

],

3085

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3086

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3090

<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3091

<pre>Sets the auto-delete flag for a disk attached to an instance.

3092

3093

Args:

3094

project: string, Project ID for this request. (required)

3095

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3096

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3097

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]

3098

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)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3099

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3100

x__xgafv: string, V1 error format.

3101

Allowed values

3102

1 - v1 error format

3103

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3104

3105

Returns:

3106

An object of the form:

3107

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3108

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3109

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3110

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3111

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3112

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3113

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3114

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3115

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3116

"code": "A String", # [Output Only] The error type identifier for this error.

3117

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3118

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3119

},

3120

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3121

},

3122

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3123

"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.

3124

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3125

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3126

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3127

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3128

"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]

3129

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3130

"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.

3131

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3132

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3133

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3134

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3135

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3136

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3137

"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.

3138

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3139

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3140

{

3141

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3142

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3143

{

3144

"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).

3145

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3146

},

3147

],

3148

"message": "A String", # [Output Only] A human-readable description of the warning code.

3149

},

3150

],

3151

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3152

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3156

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3157

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

3158

3159

Args:

3160

project: string, Project ID for this request. (required)

3161

zone: string, The name of the zone for this request. (required)

3162

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3163

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3164

The object takes the form of:

3165

3166

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3167

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

3168

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3169

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

3170

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. 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]

3171

"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.

3172

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3173

"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.

3174

"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.

3175

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3176

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3177

"A String",

3178

],

3179

"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]

3180

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3181

],

3182

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3183

"policy": { # 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. 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 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3184

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3185

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } 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]

3186

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3187

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3188

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3189

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3190

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3191

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3192

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3193

},

3194

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3195

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3196

"A String",

3197

],

3198

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3199

},

3200

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3201

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3202

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3203

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

3204

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3205

"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.

3206

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3207

"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.

3208

"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.

3209

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3210

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3211

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3212

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3213

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3214

},

3215

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3216

"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. **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.

3217

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

3218

"rules": [ # This is deprecated and has no effect. Do not use.

3219

{ # This is deprecated and has no effect. Do not use.

3220

"action": "A String", # This is deprecated and has no effect. Do not use.

3221

"conditions": [ # This is deprecated and has no effect. Do not use.

3222

{ # This is deprecated and has no effect. Do not use.

3223

"iam": "A String", # This is deprecated and has no effect. Do not use.

3224

"op": "A String", # This is deprecated and has no effect. Do not use.

3225

"svc": "A String", # This is deprecated and has no effect. Do not use.

3226

"sys": "A String", # This is deprecated and has no effect. Do not use.

3227

"values": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3232

"description": "A String", # This is deprecated and has no effect. Do not use.

3233

"ins": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3234

"A String",

3235

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3236

"logConfigs": [ # This is deprecated and has no effect. Do not use.

3237

{ # This is deprecated and has no effect. Do not use.

3238

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3239

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3240

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3241

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3242

"logName": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3243

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3244

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3245

"customFields": [ # This is deprecated and has no effect. Do not use.

3246

{ # This is deprecated and has no effect. Do not use.

3247

"name": "A String", # This is deprecated and has no effect. Do not use.

3248

"value": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3249

},

3250

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3251

"field": "A String", # This is deprecated and has no effect. Do not use.

3252

"metric": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3253

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3254

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3255

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3256

},

3257

},

3258

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3259

"notIns": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3260

"A String",

3261

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3262

"permissions": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3267

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. 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]

},

}

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3271

x__xgafv: string, V1 error format.

3272

Allowed values

3273

1 - v1 error format

3274

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3275

3276

Returns:

3277

An object of the form:

3278

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3279

{ # 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. 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 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3280

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3281

{ # 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. 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. Example Policy with multiple AuditConfigs: { "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" ] } ] } ] } 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3282

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3283

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

3284

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3285

"A String",

3286

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3287

"ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3288

"logType": "A String", # The log type that this config enables.

3289

},

3290

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3291

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3292

"A String",

3293

],

3294

"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.

3295

},

3296

],

3297

"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.

3298

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3299

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

3300

"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. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): 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'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. 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. 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]

3301

"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.

3302

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3303

"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.

3304

"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.

3305

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3306

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `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`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `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. * `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. * `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`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3307

"A String",

3308

],

3309

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

3310

},

3311

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3312

"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. **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.

3313

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

3314

"rules": [ # This is deprecated and has no effect. Do not use.

3315

{ # This is deprecated and has no effect. Do not use.

3316

"action": "A String", # This is deprecated and has no effect. Do not use.

3317

"conditions": [ # This is deprecated and has no effect. Do not use.

3318

{ # This is deprecated and has no effect. Do not use.

3319

"iam": "A String", # This is deprecated and has no effect. Do not use.

3320

"op": "A String", # This is deprecated and has no effect. Do not use.

3321

"svc": "A String", # This is deprecated and has no effect. Do not use.

3322

"sys": "A String", # This is deprecated and has no effect. Do not use.

3323

"values": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3328

"description": "A String", # This is deprecated and has no effect. Do not use.

3329

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3330

"A String",

3331

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3332

"logConfigs": [ # This is deprecated and has no effect. Do not use.

3333

{ # This is deprecated and has no effect. Do not use.

3334

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3335

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3336

"permissionType": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3337

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3338

"logName": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3339

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3340

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3341

"customFields": [ # This is deprecated and has no effect. Do not use.

3342

{ # This is deprecated and has no effect. Do not use.

3343

"name": "A String", # This is deprecated and has no effect. Do not use.

3344

"value": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3345

},

3346

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3347

"field": "A String", # This is deprecated and has no effect. Do not use.

3348

"metric": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3349

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3350

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

3351

"logMode": "A String", # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3352

},

3353

},

3354

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3355

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3356

"A String",

3357

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3358

"permissions": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3363

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * 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 **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. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. 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]

3364

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3368

<code class="details" id="setLabels">setLabels(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3369

<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]

3370

3371

Args:

3372

project: string, Project ID for this request. (required)

3373

zone: string, The name of the zone for this request. (required)

3374

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3375

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3376

The object takes the form of:

3377

3378

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3379

"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]

3384

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3385

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3386

x__xgafv: string, V1 error format.

3387

Allowed values

3388

1 - v1 error format

3389

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3390

3391

Returns:

3392

An object of the form:

3393

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3394

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3395

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3396

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3397

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3398

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3399

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3400

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3401

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3402

"code": "A String", # [Output Only] The error type identifier for this error.

3403

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3404

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3405

},

3406

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3407

},

3408

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3409

"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.

3410

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3411

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3412

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3413

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3414

"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]

3415

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3416

"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.

3417

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3418

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3419

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3420

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3421

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3422

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3423

"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.

3424

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3425

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3426

{

3427

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3428

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3429

{

3430

"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).

3431

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3432

},

3433

],

3434

"message": "A String", # [Output Only] A human-readable description of the warning code.

3435

},

3436

],

3437

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3438

}</pre>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3442

<code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3443

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

3444

3445

Args:

3446

project: string, Project ID for this request. (required)

3447

zone: string, The name of the zone for this request. (required)

3448

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3449

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3450

The object takes the form of:

3451

3452

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3453

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3454

{ # A specification of the type and number of accelerator cards attached to the instance.

3455

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3456

"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.

3457

},

3458

],

3459

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3460

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3461

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3462

x__xgafv: string, V1 error format.

3463

Allowed values

3464

1 - v1 error format

3465

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3466

3467

Returns:

3468

An object of the form:

3469

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3470

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3471

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3472

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3473

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3474

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3475

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3476

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3477

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3478

"code": "A String", # [Output Only] The error type identifier for this error.

3479

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3480

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3481

},

3482

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3483

},

3484

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3485

"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.

3486

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3487

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3488

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3489

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3490

"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]

3491

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3492

"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.

3493

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3494

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3495

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3496

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3497

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3498

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3499

"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.

3500

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3501

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3502

{

3503

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3504

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3505

{

3506

"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).

3507

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3508

},

3509

],

3510

"message": "A String", # [Output Only] A human-readable description of the warning code.

3511

},

3512

],

3513

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3514

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3518

<code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3519

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

3520

3521

Args:

3522

project: string, Project ID for this request. (required)

3523

zone: string, The name of the zone for this request. (required)

3524

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3525

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3526

The object takes the form of:

3527

3528

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3529

"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

3530

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3531

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3532

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3533

x__xgafv: string, V1 error format.

3534

Allowed values

3535

1 - v1 error format

3536

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3537

3538

Returns:

3539

An object of the form:

3540

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3541

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3542

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3543

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3544

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3545

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3546

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3547

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3548

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3549

"code": "A String", # [Output Only] The error type identifier for this error.

3550

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3551

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3552

},

3553

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3554

},

3555

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3556

"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.

3557

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3558

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3559

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3560

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3561

"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]

3562

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3563

"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.

3564

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3565

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3566

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3567

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3568

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3569

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3570

"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.

3571

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3572

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3573

{

3574

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3575

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3576

{

3577

"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).

3578

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3579

},

3580

],

3581

"message": "A String", # [Output Only] A human-readable description of the warning code.

3582

},

3583

],

3584

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3585

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3589

<code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3590

<pre>Sets metadata for the specified instance to the data included in the request.

3591

3592

Args:

3593

project: string, Project ID for this request. (required)

3594

zone: string, The name of the zone for this request. (required)

3595

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3596

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3597

The object takes the form of:

3598

3599

{ # A metadata key/value entry.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3600

"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. 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]

3601

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3602

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3603

"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.

3604

"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).

3605

},

3606

],

3607

"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]

3608

}

3609

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3610

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3611

x__xgafv: string, V1 error format.

3612

Allowed values

3613

1 - v1 error format

3614

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3615

3616

Returns:

3617

An object of the form:

3618

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3619

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3620

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3621

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3622

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3623

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3624

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3625

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3626

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3627

"code": "A String", # [Output Only] The error type identifier for this error.

3628

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3629

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

},

3631

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3632

},

3633

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3634

"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.

3635

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3636

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3637

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3638

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3639

"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]

3640

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3641

"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.

3642

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3643

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3644

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3645

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3646

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3647

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3648

"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.

3649

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3650

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3651

{

3652

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3653

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3654

{

3655

"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).

3656

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3657

},

3658

],

3659

"message": "A String", # [Output Only] A human-readable description of the warning code.

3660

},

3661

],

3662

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3663

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3667

<code class="details" id="setMinCpuPlatform">setMinCpuPlatform(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3668

<pre>Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3669

3670

Args:

3671

project: string, Project ID for this request. (required)

3672

zone: string, The name of the zone for this request. (required)

3673

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3674

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3675

The object takes the form of:

3676

3677

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3678

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

3679

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3680

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3681

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3682

x__xgafv: string, V1 error format.

3683

Allowed values

3684

1 - v1 error format

3685

2 - v2 error format

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3686

3687

Returns:

3688

An object of the form:

3689

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3690

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3691

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3692

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3693

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3694

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3695

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3696

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3697

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3698

"code": "A String", # [Output Only] The error type identifier for this error.

3699

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3700

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3701

},

3702

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3703

},

3704

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3705

"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.

3706

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3707

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3708

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3709

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3710

"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]

3711

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3712

"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.

3713

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3714

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3715

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3716

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3717

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3718

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3719

"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.

3720

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3721

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3722

{

3723

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3724

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3725

{

3726

"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).

3727

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3728

},

3729

],

3730

"message": "A String", # [Output Only] A human-readable description of the warning code.

3731

},

3732

],

3733

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3734

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3738

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3739

<pre>Sets name of an instance.

3740

3741

Args:

3742

project: string, Project ID for this request. (required)

3743

zone: string, The name of the zone for this request. (required)

3744

instance: string, The instance name for this request. (required)

3745

body: object, The request body.

3746

The object takes the form of:

3747

3748

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3749

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

3750

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

3751

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3752

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3753

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3754

x__xgafv: string, V1 error format.

3755

Allowed values

3756

1 - v1 error format

3757

2 - v2 error format

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3758

3759

Returns:

3760

An object of the form:

3761

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3762

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3763

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3764

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3765

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3766

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3767

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3768

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3769

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3770

"code": "A String", # [Output Only] The error type identifier for this error.

3771

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3772

"message": "A String", # [Output Only] An optional, human-readable error message.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3773

},

3774

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3775

},

3776

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3777

"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.

3778

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3779

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3780

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3781

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3782

"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]

3783

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3784

"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.

3785

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3786

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3787

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3788

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3789

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3790

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3791

"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.

3792

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3793

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3794

{

3795

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3796

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3797

{

3798

"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).

3799

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3800

},

3801

],

3802

"message": "A String", # [Output Only] A human-readable description of the warning code.

3803

},

3804

],

3805

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3806

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3810

<code class="details" id="setScheduling">setScheduling(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3811

<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]

3812

3813

Args:

3814

project: string, Project ID for this request. (required)

3815

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3816

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3817

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3818

The object takes the form of:

3819

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3820

{ # Sets the scheduling options for an Instance. NextID: 21

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3821

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3822

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3823

"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]

3824

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

3825

"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]

3826

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3827

"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]

3828

{ # 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]

3829

"key": "A String", # Corresponds to the label key of Node resource.

3830

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3831

"values": [ # Corresponds to the label values of Node resource.

3832

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3833

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3834

},

3835

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3836

"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]

3837

"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]

3838

}

3839

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3840

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3841

x__xgafv: string, V1 error format.

3842

Allowed values

3843

1 - v1 error format

3844

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3845

3846

Returns:

3847

An object of the form:

3848

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3849

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3850

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3851

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3852

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3853

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3854

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3855

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3856

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3857

"code": "A String", # [Output Only] The error type identifier for this error.

3858

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3859

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3860

},

3861

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3862

},

3863

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3864

"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.

3865

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3866

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3867

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3868

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3869

"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]

3870

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3871

"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.

3872

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3873

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3874

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3875

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3876

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3877

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3878

"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.

3879

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3880

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3881

{

3882

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3883

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3884

{

3885

"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).

3886

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3887

},

3888

],

3889

"message": "A String", # [Output Only] A human-readable description of the warning code.

3890

},

3891

],

3892

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3893

}</pre>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3897

<code class="details" id="setServiceAccount">setServiceAccount(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3898

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3899

3900

Args:

3901

project: string, Project ID for this request. (required)

3902

zone: string, The name of the zone for this request. (required)

3903

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3904

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3905

The object takes the form of:

3906

3907

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3908

"email": "A String", # Email address of the service account.

3909

"scopes": [ # The list of scopes to be made available for this service account.

3910

"A String",

3911

],

3912

}

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3913

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3914

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3915

x__xgafv: string, V1 error format.

3916

Allowed values

3917

1 - v1 error format

3918

2 - v2 error format

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

3919

3920

Returns:

3921

An object of the form:

3922

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3923

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3924

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3925

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3926

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3927

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3928

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3929

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3930

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3931

"code": "A String", # [Output Only] The error type identifier for this error.

3932

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3933

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3934

},

3935

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3936

},

3937

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3938

"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.

3939

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3940

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3941

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3942

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3943

"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]

3944

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3945

"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.

3946

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3947

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3948

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3949

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3950

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3951

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3952

"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.

3953

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3954

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3955

{

3956

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3957

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3958

{

3959

"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).

3960

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3961

},

3962

],

3963

"message": "A String", # [Output Only] A human-readable description of the warning code.

3964

},

3965

],

3966

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3967

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3971

<code class="details" id="setShieldedInstanceIntegrityPolicy">setShieldedInstanceIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3972

<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.

3973

3974

Args:

3975

project: string, Project ID for this request. (required)

3976

zone: string, The name of the zone for this request. (required)

3977

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3978

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3979

The object takes the form of:

3980

3981

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3982

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3983

}

3984

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3985

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3986

x__xgafv: string, V1 error format.

3987

Allowed values

3988

1 - v1 error format

3989

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3990

3991

Returns:

3992

An object of the form:

3993

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3994

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3995

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3996

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3997

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3998

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3999

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4000

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4001

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4002

"code": "A String", # [Output Only] The error type identifier for this error.

4003

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4004

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4005

},

4006

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4007

},

4008

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4009

"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.

4010

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4011

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4012

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4013

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4014

"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]

4015

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4016

"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.

4017

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4018

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4019

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4020

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4021

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4022

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4023

"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.

4024

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4025

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4026

{

4027

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4028

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4029

{

4030

"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).

4031

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4032

},

4033

],

4034

"message": "A String", # [Output Only] A human-readable description of the warning code.

4035

},

4036

],

4037

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4038

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4042

<code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4043

<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.

4044

4045

Args:

4046

project: string, Project ID for this request. (required)

4047

zone: string, The name of the zone for this request. (required)

4048

instance: string, Name of the instance scoping this request. (required)

4049

body: object, The request body.

4050

The object takes the form of:

4051

4052

{ # The policy describes the baseline against which VM instance boot integrity is measured.

4053

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4054

}

4055

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4056

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4057

x__xgafv: string, V1 error format.

4058

Allowed values

4059

1 - v1 error format

4060

2 - v2 error format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4061

4062

Returns:

4063

An object of the form:

4064

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4065

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4066

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4067

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4068

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4069

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4070

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4071

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4072

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4073

"code": "A String", # [Output Only] The error type identifier for this error.

4074

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4075

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4076

},

4077

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4078

},

4079

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4080

"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.

4081

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4082

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4083

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4084

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4085

"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]

4086

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4087

"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.

4088

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4089

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4090

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4091

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4092

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4093

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4094

"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.

4095

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4096

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4097

{

4098

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4099

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4100

{

4101

"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).

4102

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4103

},

4104

],

4105

"message": "A String", # [Output Only] A human-readable description of the warning code.

4106

},

4107

],

4108

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4109

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4113

<code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4114

<pre>Sets network tags for the specified instance to the data included in the request.

4115

4116

Args:

4117

project: string, Project ID for this request. (required)

4118

zone: string, The name of the zone for this request. (required)

4119

instance: string, Name of the instance scoping this request. (required)

4120

body: object, The request body.

4121

The object takes the form of:

4122

4123

{ # A set of instance tags.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4124

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4125

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

}

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4130

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4131

x__xgafv: string, V1 error format.

4132

Allowed values

4133

1 - v1 error format

4134

2 - v2 error format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4135

4136

Returns:

4137

An object of the form:

4138

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4139

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4140

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4141

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4142

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4143

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4144

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4145

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4146

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4147

"code": "A String", # [Output Only] The error type identifier for this error.

4148

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4149

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4150

},

4151

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4152

},

4153

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4154

"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.

4155

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4156

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4157

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4158

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4159

"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]

4160

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4161

"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.

4162

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4163

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4164

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4165

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4166

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4167

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4168

"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.

4169

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4170

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4171

{

4172

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4173

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4174

{

4175

"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).

4176

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4177

},

4178

],

4179

"message": "A String", # [Output Only] A human-readable description of the warning code.

4180

},

4181

],

4182

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4183

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4187

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4188

<pre>Simulates a maintenance event on the instance.

4189

4190

Args:

4191

project: string, Project ID for this request. (required)

4192

zone: string, The name of the zone for this request. (required)

4193

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4194

x__xgafv: string, V1 error format.

4195

Allowed values

4196

1 - v1 error format

4197

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4198

4199

Returns:

4200

An object of the form:

4201

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4202

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4203

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4204

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4205

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4206

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4207

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4208

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4209

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4210

"code": "A String", # [Output Only] The error type identifier for this error.

4211

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4212

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4213

},

4214

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4215

},

4216

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4217

"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.

4218

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4219

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4220

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4221

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4222

"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]

4223

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4224

"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.

4225

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4226

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4227

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4228

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4229

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4230

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4231

"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.

4232

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4233

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4234

{

4235

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4236

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4237

{

4238

"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).

4239

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4240

},

4241

],

4242

"message": "A String", # [Output Only] A human-readable description of the warning code.

4243

},

4244

],

4245

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4246

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4250

<code class="details" id="start">start(project, zone, instance, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4251

<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]

4252

4253

Args:

4254

project: string, Project ID for this request. (required)

4255

zone: string, The name of the zone for this request. (required)

4256

instance: string, Name of the instance resource to start. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4257

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4258

x__xgafv: string, V1 error format.

4259

Allowed values

4260

1 - v1 error format

4261

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4262

4263

Returns:

4264

An object of the form:

4265

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4266

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4267

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4268

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4269

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4270

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4271

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4272

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4273

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4274

"code": "A String", # [Output Only] The error type identifier for this error.

4275

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4276

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4277

},

4278

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4279

},

4280

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4281

"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.

4282

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4283

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4284

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4285

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4286

"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]

4287

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4288

"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.

4289

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4290

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4291

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4292

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4293

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4294

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4295

"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.

4296

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4297

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4298

{

4299

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4300

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4301

{

4302

"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).

4303

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4304

},

4305

],

4306

"message": "A String", # [Output Only] A human-readable description of the warning code.

4307

},

4308

],

4309

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4310

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4314

<code class="details" id="startWithEncryptionKey">startWithEncryptionKey(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4315

<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]

4316

4317

Args:

4318

project: string, Project ID for this request. (required)

4319

zone: string, The name of the zone for this request. (required)

4320

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4321

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4322

The object takes the form of:

4323

4324

{

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4325

"disks": [ # Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to start the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4326

{

4327

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

4328

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4329

"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.

4330

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4331

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4332

"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]

4333

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4334

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

4335

},

4336

],

4337

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4338

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4339

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4340

x__xgafv: string, V1 error format.

4341

Allowed values

4342

1 - v1 error format

4343

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4344

4345

Returns:

4346

An object of the form:

4347

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4348

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4349

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4350

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4351

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4352

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4353

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4354

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4355

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4356

"code": "A String", # [Output Only] The error type identifier for this error.

4357

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4358

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4359

},

4360

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4361

},

4362

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4363

"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.

4364

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4365

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4366

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4367

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4368

"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]

4369

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4370

"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.

4371

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4372

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4373

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4374

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4375

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4376

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4377

"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.

4378

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4379

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4380

{

4381

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4382

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4383

{

4384

"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).

4385

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4386

},

4387

],

4388

"message": "A String", # [Output Only] A human-readable description of the warning code.

4389

},

4390

],

4391

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4392

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4396

<code class="details" id="stop">stop(project, zone, instance, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4397

<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]

4398

4399

Args:

4400

project: string, Project ID for this request. (required)

4401

zone: string, The name of the zone for this request. (required)

4402

instance: string, Name of the instance resource to stop. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4403

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4404

x__xgafv: string, V1 error format.

4405

Allowed values

4406

1 - v1 error format

4407

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4408

4409

Returns:

4410

An object of the form:

4411

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4412

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4413

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4414

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4415

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4416

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4417

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4418

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4419

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4420

"code": "A String", # [Output Only] The error type identifier for this error.

4421

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4422

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4423

},

4424

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4425

},

4426

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4427

"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.

4428

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4429

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4430

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4431

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4432

"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]

4433

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4434

"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.

4435

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4436

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4437

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4438

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4439

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4440

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4441

"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.

4442

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4443

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4444

{

4445

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4446

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4447

{

4448

"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).

4449

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4450

},

4451

],

4452

"message": "A String", # [Output Only] A human-readable description of the warning code.

4453

},

4454

],

4455

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4456

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4460

<code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4461

<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.

4462

4463

Args:

4464

project: string, Project ID for this request. (required)

4465

zone: string, The name of the zone for this request. (required)

4466

instance: string, Name of the instance resource to suspend. (required)

4467

discardLocalSsd: boolean, If true, discard the contents of any attached localSSD partitions. Default value is false (== preserve localSSD data).

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4468

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4469

x__xgafv: string, V1 error format.

4470

Allowed values

4471

1 - v1 error format

4472

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4473

4474

Returns:

4475

An object of the form:

4476

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4477

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4478

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4479

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4480

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4481

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4482

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4483

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4484

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4485

"code": "A String", # [Output Only] The error type identifier for this error.

4486

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4487

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4488

},

4489

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4490

},

4491

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4492

"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.

4493

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4494

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4495

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4496

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4497

"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]

4498

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4499

"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.

4500

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4501

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4502

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4503

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4504

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4505

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4506

"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.

4507

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4508

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4509

{

4510

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4511

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4512

{

4513

"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).

4514

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4515

},

4516

],

4517

"message": "A String", # [Output Only] A human-readable description of the warning code.

4518

},

4519

],

4520

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4521

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4525

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4526

<pre>Returns permissions that a caller has on the specified resource.

4527

4528

Args:

4529

project: string, Project ID for this request. (required)

4530

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4531

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4532

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4533

The object takes the form of:

4534

4535

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4536

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

4537

"A String",

4538

],

4539

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4540

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4541

x__xgafv: string, V1 error format.

4542

Allowed values

4543

1 - v1 error format

4544

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4545

4546

Returns:

4547

An object of the form:

4548

4549

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4550

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

4551

"A String",

4552

],

4553

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4554

</div>

4555

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4556

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4557

<code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code>

4558

<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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4559

4560

Args:

4561

project: string, Project ID for this request. (required)

4562

zone: string, The name of the zone for this request. (required)

4563

instance: string, Name of the instance resource to update. (required)

4564

body: object, The request body.

4565

The object takes the form of:

4566

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4567

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4568

"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.

4569

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

4570

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4571

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4572

"canIpForward": True or False, # Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4573

"confidentialInstanceConfig": { # A set of Confidential Instance options.

4574

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

4575

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4576

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

4577

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4578

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

4579

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4580

"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]

4581

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4582

"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).

4583

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4584

"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. 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.

4585

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. 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. 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. 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. 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]

4586

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4587

"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.

4588

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4589

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4590

"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]

4591

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4592

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4593

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

4594

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4595

"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

2020-05-20 12:08:20 -0700

[diff] [blame]

4596

},

4597

],

4598

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4599

"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. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [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. 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]

4600

"description": "A String", # An optional description. Provide this property when creating the disk.

4601

"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.

4602

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

4603

"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: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4604

"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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4605

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4606

"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]

4607

},

4608

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4609

"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.

4610

"a_key": "A String",

4611

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4612

"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]

4613

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

4614

"provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4615

"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.

4616

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4617

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4618

"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. 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: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image 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: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

4619

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. 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]

4620

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4621

"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.

4622

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4623

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4624

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4625

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4626

"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. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4627

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4628

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4629

"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.

4630

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4631

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4632

"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]

4633

},

4634

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4635

"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.

4636

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

4637

"licenses": [ # [Output Only] Any valid publicly visible licenses.

4638

"A String",

4639

],

4640

"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.

4641

"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

4642

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4643

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4644

"content": "A String", # The raw content in the secure keys file.

4645

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4646

},

4647

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4648

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4649

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4650

"content": "A String", # The raw content in the secure keys file.

4651

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4652

},

4653

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4654

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4655

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4656

"content": "A String", # The raw content in the secure keys file.

4657

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4658

},

4659

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4660

"pk": { # The Platform Key (PK).

4661

"content": "A String", # The raw content in the secure keys file.

4662

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4663

},

4664

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4665

"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. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. 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]

4666

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4667

},

4668

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4669

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

4670

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

4671

},

4672

"eraseWindowsVssSignature": True or False, # Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4673

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4674

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

4675

{ # A specification of the type and number of accelerator cards attached to the instance.

4676

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4677

"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.

4678

},

4679

],

4680

"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.

4681

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4682

"kind": "compute#instance", # [Output Only] Type of the resource. Always compute#instance for instances.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4683

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4684

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

4685

"a_key": "A String",

4686

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

4687

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

4688

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

4689

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4690

"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: zones/us-central1-f/machineTypes/n1-standard-1 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): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4691

"metadata": { # A metadata key/value entry. # The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4692

"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. 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]

4693

"items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4694

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4695

"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.

4696

"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).

4697

},

4698

],

4699

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

4700

},

4701

"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".

4702

"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.

4703

"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.

4704

{ # A network interface resource attached to an instance.

4705

"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.

4706

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4707

"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.

4708

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4709

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4710

"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.

4711

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4712

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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]

4713

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4714

"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.

4715

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4716

},

4717

],

4718

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4719

{ # An alias IP range attached to an instance's network interface.

4720

"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).

4721

"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.

4722

},

4723

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4724

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4725

"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.

4726

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4727

"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.

4728

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4729

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4730

"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.

4731

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4732

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4733

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4734

"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.

4735

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4736

},

4737

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4738

"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. Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4739

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

4740

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4741

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4742

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4743

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4744

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4745

"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. This field can be both set at instance creation and update network interface operations.

4746

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4747

},

4748

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4749

"networkPerformanceConfig": {

4750

"totalEgressBandwidthTier": "A String",

4751

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4752

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4753

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4754

"reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that this instance can consume from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4755

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4756

"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]

4757

"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.

4762

"A String",

4763

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4764

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4765

"scheduling": { # Sets the scheduling options for an Instance. NextID: 21 # Sets the scheduling options for this instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4766

"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. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

4767

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4768

"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]

4769

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

4770

"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]

4771

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4772

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

4773

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

4774

"key": "A String", # Corresponds to the label key of Node resource.

4775

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4776

"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]

4782

"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]

4783

},

4784

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4785

"serviceAccounts": [ # A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4786

{ # A service account.

4787

"email": "A String", # Email address of the service account.

4788

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

4794

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4795

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4796

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

4797

},

4798

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

4799

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4800

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4801

"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]

4802

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

4803

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

4804

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

4805

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4806

"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]

4807

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4808

},

4809

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4810

"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]

4811

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4812

"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.

4813

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4814

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4815

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4816

},

4817

"startRestricted": True or False, # [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4818

"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]

4819

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

4820

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4821

"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. To see the latest fingerprint, make get() request to the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4822

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4827

}

4828

4829

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.

4830

Allowed values

4831

INVALID -

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4832

NO_EFFECT - No changes can be made to the instance.

4833

REFRESH - The instance will not restart.

4834

RESTART - The instance will restart.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4835

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.

4836

Allowed values

4837

INVALID -

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4838

NO_EFFECT - No changes can be made to the instance.

4839

REFRESH - The instance will not restart.

4840

RESTART - The instance will restart.

4841

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4842

x__xgafv: string, V1 error format.

4843

Allowed values

4844

1 - v1 error format

4845

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4846

4847

Returns:

4848

An object of the form:

4849

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4850

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4851

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4852

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4853

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4854

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4855

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4856

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4857

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4858

"code": "A String", # [Output Only] The error type identifier for this error.

4859

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4860

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4861

},

4862

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4863

},

4864

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4865

"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.

4866

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4867

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4868

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4869

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4870

"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]

4871

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4872

"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.

4873

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4874

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4875

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4876

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4877

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4878

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4879

"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.

4880

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4881

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4882

{

4883

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4884

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4885

{

4886

"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).

4887

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4888

},

4889

],

4890

"message": "A String", # [Output Only] A human-readable description of the warning code.

4891

},

4892

],

4893

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4894

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4898

<code class="details" id="updateAccessConfig">updateAccessConfig(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4899

<pre>Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4900

4901

Args:

4902

project: string, Project ID for this request. (required)

4903

zone: string, The name of the zone for this request. (required)

4904

instance: string, The instance name for this request. (required)

4905

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]

4906

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4907

The object takes the form of:

4908

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4909

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4910

"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.

4911

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4912

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4913

"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.

4914

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4915

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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]

4916

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4917

"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.

4918

"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]

4919

}

4920

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4921

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4922

x__xgafv: string, V1 error format.

4923

Allowed values

4924

1 - v1 error format

4925

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4926

4927

Returns:

4928

An object of the form:

4929

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4930

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4931

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4932

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4933

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4934

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4935

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4936

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4937

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4938

"code": "A String", # [Output Only] The error type identifier for this error.

4939

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4940

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4941

},

4942

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4943

},

4944

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4945

"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.

4946

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4947

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4948

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4949

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4950

"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]

4951

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4952

"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.

4953

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4954

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4955

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4956

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4957

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4958

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4959

"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.

4960

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4961

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4962

{

4963

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4964

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4965

{

4966

"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).

4967

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4968

},

4969

],

4970

"message": "A String", # [Output Only] A human-readable description of the warning code.

4971

},

4972

],

4973

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4974

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4978

<code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4979

<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.

4980

4981

Args:

4982

project: string, Project ID for this request. (required)

4983

zone: string, The name of the zone for this request. (required)

4984

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4985

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4986

The object takes the form of:

4987

4988

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4989

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4990

}

4991

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4992

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

4993

x__xgafv: string, V1 error format.

4994

Allowed values

4995

1 - v1 error format

4996

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4997

4998

Returns:

4999

An object of the form:

5000

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5001

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5002

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5003

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5004

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5005

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5006

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5007

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5008

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5009

"code": "A String", # [Output Only] The error type identifier for this error.

5010

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5011

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5012

},

5013

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5014

},

5015

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5016

"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.

5017

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5018

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5019

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5020

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5021

"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]

5022

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5023

"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.

5024

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5025

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5026

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5027

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5028

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5029

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5030

"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.

5031

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5032

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5033

{

5034

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5035

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5036

{

5037

"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).

5038

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5039

},

5040

],

5041

"message": "A String", # [Output Only] A human-readable description of the warning code.

5042

},

5043

],

5044

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5045

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5049

<code class="details" id="updateNetworkInterface">updateNetworkInterface(project, zone, instance, networkInterface, body=None, requestId=None, x__xgafv=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5050

<pre>Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5051

5052

Args:

5053

project: string, Project ID for this request. (required)

5054

zone: string, The name of the zone for this request. (required)

5055

instance: string, The instance name for this request. (required)

5056

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5057

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5058

The object takes the form of:

5059

5060

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5061

"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.

5062

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

5063

"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.

5064

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5065

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5066

"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.

5067

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5068

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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]

5069

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5070

"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.

5071

"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]

5072

},

5073

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5074

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

5075

{ # An alias IP range attached to an instance's network interface.

5076

"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).

5077

"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.

5078

},

5079

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

5080

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

5081

"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.

5082

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5083

"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.

5084

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

5085

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5086

"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.

5087

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5088

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. 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.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

5089

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

5090

"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.

5091

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

5092

},

5093

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5094

"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. Valid only if stackType is IPV4_IPV6.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5095

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

5096

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

5097

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5098

"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. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5099

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5100

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5101

"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. This field can be both set at instance creation and update network interface operations.

5102

"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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5103

}

5104

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5105

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

5106

x__xgafv: string, V1 error format.

5107

Allowed values

5108

1 - v1 error format

5109

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5110

5111

Returns:

5112

An object of the form:

5113

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5114

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5115

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5116

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5117

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5118

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5119

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5120

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5121

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5122

"code": "A String", # [Output Only] The error type identifier for this error.

5123

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5124

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5125

},

5126

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5127

},

5128

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5129

"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.

5130

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5131

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5132

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5133

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5134

"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]

5135

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5136

"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.

5137

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5138

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5139

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5140

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5141

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5142

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5143

"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.

5144

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5145

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5146

{

5147

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5148

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5149

{

5150

"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).

5151

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5152

},

5153

],

5154

"message": "A String", # [Output Only] A human-readable description of the warning code.

5155

},

5156

],

5157

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5158

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5162

<code class="details" id="updateShieldedInstanceConfig">updateShieldedInstanceConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5163

<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.

5164

5165

Args:

5166

project: string, Project ID for this request. (required)

5167

zone: string, The name of the zone for this request. (required)

5168

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5169

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5170

The object takes the form of:

5171

5172

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5173

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

5174

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

5175

"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]

5176

}

5177

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5178

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

5179

x__xgafv: string, V1 error format.

5180

Allowed values

5181

1 - v1 error format

5182

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5183

5184

Returns:

5185

An object of the form:

5186

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5187

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5188

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5189

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5190

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5191

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5192

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5193

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5194

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5195

"code": "A String", # [Output Only] The error type identifier for this error.

5196

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5197

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5198

},

5199

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5200

},

5201

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5202

"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.

5203

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5204

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5205

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5206

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5207

"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]

5208

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5209

"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.

5210

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5211

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5212

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5213

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5214

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5215

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5216

"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.

5217

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5218

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5219

{

5220

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5221

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5222

{

5223

"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).

5224

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5225

},

5226

],

5227

"message": "A String", # [Output Only] A human-readable description of the warning code.

5228

},

5229

],

5230

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5231

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5235

<code class="details" id="updateShieldedVmConfig">updateShieldedVmConfig(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5236

<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.

5237

5238

Args:

5239

project: string, Project ID for this request. (required)

5240

zone: string, The name of the zone for this request. (required)

5241

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5242

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5243

The object takes the form of:

5244

5245

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5246

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

5247

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

5248

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5249

}

5250

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5251

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

5252

x__xgafv: string, V1 error format.

5253

Allowed values

5254

1 - v1 error format

5255

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5256

5257

Returns:

5258

An object of the form:

5259

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5260

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5261

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5262

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5263

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5264

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5265

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5266

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5267

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5268

"code": "A String", # [Output Only] The error type identifier for this error.

5269

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5270

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5271

},

5272

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5273

},

5274

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5275

"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.

5276

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5277

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5278

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5279

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5280

"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]

5281

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5282

"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.

5283

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5284

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5285

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5286

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5287

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5288

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5289

"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.

5290

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5291

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5292

{

5293

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5294

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot