Blame - docs/dyn/compute_alpha.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>

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

85

<p class="firstline">Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.</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>

Dan O'Meara

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

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

Bu Sun Kim

2019-06-14 16:50:42 -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>

Sai Cheemalapati

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

[diff] [blame]

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>

Sai Cheemalapati

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

[diff] [blame]

118

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

119

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-08-24 00:22:31 -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="#performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</a></code></p>

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

148

<p class="firstline">Perform a manual maintenance on the instance.</p>

149

yoshi-code-bot

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

[diff] [blame]

150

<code><a href="#removeResourcePolicies">removeResourcePolicies(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]

151

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

152

yoshi-code-bot

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

[diff] [blame]

153

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

154

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

155

yoshi-code-bot

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

[diff] [blame]

156

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

157

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

158

yoshi-code-bot

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

[diff] [blame]

159

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

160

<p class="firstline">Sends diagnostic interrupt to the instance.</p>

yoshi-code-bot

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

[diff] [blame]

161

yoshi-code-bot

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

[diff] [blame]

162

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

163

<p class="firstline">Sets deletion protection on the instance.</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="#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]

166

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

167

yoshi-code-bot

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

[diff] [blame]

168

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

Sai Cheemalapati

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

[diff] [blame]

169

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

170

yoshi-code-bot

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

[diff] [blame]

171

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

172

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

Sai Cheemalapati

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

[diff] [blame]

173

yoshi-code-bot

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

[diff] [blame]

174

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

175

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

176

yoshi-code-bot

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

[diff] [blame]

177

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

178

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

179

yoshi-code-bot

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

[diff] [blame]

180

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

181

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

182

yoshi-code-bot

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

[diff] [blame]

183

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

184

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

185

yoshi-code-bot

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

[diff] [blame]

186

<code><a href="#setName">setName(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]

187

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

Sai Cheemalapati

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

[diff] [blame]

188

yoshi-code-bot

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

[diff] [blame]

189

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

190

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

191

yoshi-code-bot

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

[diff] [blame]

192

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

193

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

Sai Cheemalapati

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

[diff] [blame]

194

yoshi-code-bot

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

[diff] [blame]

195

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

196

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

197

yoshi-code-bot

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

[diff] [blame]

198

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

199

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

200

yoshi-code-bot

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

[diff] [blame]

201

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

202

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

203

yoshi-code-bot

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

[diff] [blame]

204

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

Sai Cheemalapati

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

[diff] [blame]

205

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

206

yoshi-code-bot

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

[diff] [blame]

207

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

208

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

Sai Cheemalapati

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

[diff] [blame]

209

yoshi-code-bot

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

[diff] [blame]

210

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

211

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

Sai Cheemalapati

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

[diff] [blame]

212

yoshi-code-bot

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

[diff] [blame]

213

<code><a href="#stop">stop(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]

214

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

Sai Cheemalapati

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

[diff] [blame]

215

yoshi-code-bot

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

[diff] [blame]

216

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

Sai Cheemalapati

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

[diff] [blame]

217

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

218

yoshi-code-bot

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

[diff] [blame]

219

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

220

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

221

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

222

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

yoshi-code-bot

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

[diff] [blame]

223

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

224

yoshi-code-bot

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

[diff] [blame]

225

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

226

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

227

yoshi-code-bot

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

[diff] [blame]

228

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

229

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

Sai Cheemalapati

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

[diff] [blame]

230

yoshi-code-bot

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

[diff] [blame]

231

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

232

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

233

yoshi-code-bot

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

[diff] [blame]

234

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

235

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

236

yoshi-code-bot

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

[diff] [blame]

237

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

238

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

239

<h3>Method Details</h3>

240

yoshi-code-bot

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

[diff] [blame]

241

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

242

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

Sai Cheemalapati

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

[diff] [blame]

243

244

Args:

245

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

246

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

247

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

248

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]

249

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

250

The object takes the form of:

251

Bu Sun Kim

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

[diff] [blame]

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

257

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

258

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

259

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

260

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

Bu Sun Kim

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

[diff] [blame]

261

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

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

264

}

265

yoshi-code-bot

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

[diff] [blame]

266

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

267

x__xgafv: string, V1 error format.

268

Allowed values

269

1 - v1 error format

270

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

271

272

Returns:

273

An object of the form:

274

yoshi-code-bot

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

[diff] [blame]

275

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

276

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

277

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

278

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

279

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

280

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

281

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

Bu Sun Kim

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

[diff] [blame]

282

{

Yoshi Automation Bot

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

[diff] [blame]

283

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

284

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

285

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

Bu Sun Kim

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

[diff] [blame]

286

},

287

],

Yoshi Automation Bot

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

[diff] [blame]

288

},

289

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

290

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

291

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

292

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

293

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

294

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

yoshi-code-bot

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

[diff] [blame]

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

{

309

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

310

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

311

{

312

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

313

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

314

},

315

],

316

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

317

},

318

],

319

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

320

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

324

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

Bu Sun Kim

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

[diff] [blame]

325

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

326

327

Args:

328

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

329

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

330

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

Dan O'Meara

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

[diff] [blame]

331

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

332

The object takes the form of:

333

334

{

Yoshi Automation Bot

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

[diff] [blame]

335

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

336

"A String",

337

],

338

}

Bu Sun Kim

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

[diff] [blame]

339

yoshi-code-bot

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

[diff] [blame]

340

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

341

x__xgafv: string, V1 error format.

342

Allowed values

343

1 - v1 error format

344

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

345

346

Returns:

347

An object of the form:

348

yoshi-code-bot

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

[diff] [blame]

349

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

350

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

351

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

352

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

353

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

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

{

Yoshi Automation Bot

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

[diff] [blame]

357

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

358

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

359

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

Bu Sun Kim

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

[diff] [blame]

360

},

361

],

Yoshi Automation Bot

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

[diff] [blame]

362

},

363

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

364

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

365

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

366

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

367

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

368

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

yoshi-code-bot

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

[diff] [blame]

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

{

383

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

384

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

385

{

386

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

387

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

388

},

389

],

390

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

391

},

392

],

393

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

394

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

398

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

399

<pre>Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances.

Sai Cheemalapati

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

[diff] [blame]

400

401

Args:

402

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

yoshi-code-bot

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

[diff] [blame]

403

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]

404

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]

405

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]

406

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]

407

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]

408

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]

409

x__xgafv: string, V1 error format.

410

Allowed values

411

1 - v1 error format

412

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

413

414

Returns:

415

An object of the form:

416

417

{

Yoshi Automation Bot

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

[diff] [blame]

418

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

419

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

420

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

421

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

yoshi-code-bot

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

[diff] [blame]

422

{ # 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 Automation Bot

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

[diff] [blame]

423

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

424

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

425

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

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

[diff] [blame]

426

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

Yoshi Automation Bot

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

[diff] [blame]

427

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

yoshi-code-bot

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

[diff] [blame]

428

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

Yoshi Automation Bot

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

[diff] [blame]

429

},

yoshi-code-bot

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

[diff] [blame]

430

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

431

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

432

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

433

},

434

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

435

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

436

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

437

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

438

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

439

{ # An instance-attached disk resource.

440

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

441

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

442

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

443

"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-10-05 00:20:14 -0700

[diff] [blame]

444

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

445

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

446

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

447

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

448

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

449

},

450

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

451

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

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

[diff] [blame]

452

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

453

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame]

454

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

455

},

456

],

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame]

465

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

466

},

467

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

468

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Yoshi Automation Bot

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

[diff] [blame]

469

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

470

"a_key": "A String",

471

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

472

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

473

"A String",

474

],

475

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

476

"A String",

477

],

Yoshi Automation Bot

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

[diff] [blame]

478

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

479

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

480

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

481

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

482

"A String",

483

],

484

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

485

"A String",

486

],

yoshi-code-bot

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

[diff] [blame]

487

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

488

"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-10-05 00:20:14 -0700

[diff] [blame]

489

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

490

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

491

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

492

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

493

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

494

},

yoshi-code-bot

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

[diff] [blame]

495

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

496

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

497

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

498

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

499

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

500

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

501

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

502

},

Yoshi Automation Bot

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

[diff] [blame]

503

},

504

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

505

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

506

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

507

"A String",

508

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

509

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Yoshi Automation Bot

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

[diff] [blame]

510

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

511

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

512

"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

513

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

514

{

Bu Sun Kim

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

[diff] [blame]

515

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

516

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

Bu Sun Kim

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

[diff] [blame]

517

},

Yoshi Automation Bot

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

[diff] [blame]

518

],

519

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

520

{

521

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

522

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

523

},

524

],

525

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

526

{

527

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

528

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

529

},

530

],

531

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

532

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

533

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

Bu Sun Kim

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

[diff] [blame]

534

},

Sai Cheemalapati

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

[diff] [blame]

535

},

yoshi-code-bot

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

[diff] [blame]

536

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

537

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

538

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

Bu Sun Kim

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

[diff] [blame]

539

"A String",

540

],

541

},

Sai Cheemalapati

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

[diff] [blame]

542

],

Yoshi Automation Bot

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

[diff] [blame]

543

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

544

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

545

},

546

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

547

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

548

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

549

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

550

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

551

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

552

},

553

],

554

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

555

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

yoshi-code-bot

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

[diff] [blame]

556

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

557

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

558

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

559

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

560

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

561

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

562

},

563

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

564

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

565

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

566

"a_key": "A String",

567

},

568

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

569

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

570

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

yoshi-code-bot

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

[diff] [blame]

571

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

572

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

573

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

574

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

575

{ # Metadata

Yoshi Automation Bot

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

[diff] [blame]

576

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

577

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

578

},

579

],

580

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

581

},

582

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

583

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

584

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

585

{ # A network interface resource attached to an instance.

586

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

587

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

588

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

589

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

590

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

591

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

592

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

593

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

594

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

595

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

Yoshi Automation Bot

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

[diff] [blame]

596

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

597

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

Yoshi Automation Bot

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

[diff] [blame]

598

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

599

},

600

],

601

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

602

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

603

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

604

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

605

},

606

],

yoshi-code-bot

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

[diff] [blame]

607

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

Yoshi Automation Bot

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

[diff] [blame]

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

618

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

Yoshi Automation Bot

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

[diff] [blame]

619

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

620

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

Yoshi Automation Bot

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

[diff] [blame]

621

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

622

},

623

],

yoshi-code-bot

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

[diff] [blame]

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

yoshi-code-bot

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

[diff] [blame]

632

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

yoshi-code-bot

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

[diff] [blame]

633

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

634

{

yoshi-code-bot

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

[diff] [blame]

635

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

636

"ipAllocationMode": "A String",

yoshi-code-bot

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

[diff] [blame]

637

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

638

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

639

},

640

],

yoshi-code-bot

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

[diff] [blame]

641

"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 Automation Bot

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

[diff] [blame]

642

},

643

],

yoshi-code-bot

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

[diff] [blame]

644

"networkPerformanceConfig": {

645

"externalIpEgressBandwidthTier": "A String",

646

"totalEgressBandwidthTier": "A String",

647

},

Yoshi Automation Bot

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

[diff] [blame]

648

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

649

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

yoshi-code-bot

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

[diff] [blame]

650

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

651

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

652

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

653

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

654

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

Yoshi Automation Bot

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

[diff] [blame]

"A String",

],

},

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

659

"A String",

660

],

yoshi-code-bot

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

[diff] [blame]

661

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

662

"scheduling": {

663

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

664

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

665

"upcomingMaintenance": {

666

"canReschedule": True or False, # Indicates if the maintenance can be customer triggered. See go/sf-ctm-design for more details

667

},

yoshi-code-bot

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

[diff] [blame]

668

},

Yoshi Automation Bot

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

[diff] [blame]

669

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

yoshi-code-bot

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

[diff] [blame]

670

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

671

"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-03-02 11:49:08 -0800

[diff] [blame]

672

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

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

673

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

674

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

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

[diff] [blame]

675

"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-08-31 00:28:27 -0700

[diff] [blame]

676

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Yoshi Automation Bot

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

[diff] [blame]

677

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

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

692

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

yoshi-code-bot

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

[diff] [blame]

693

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Yoshi Automation Bot

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

[diff] [blame]

694

},

yoshi-code-bot

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

[diff] [blame]

695

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

Yoshi Automation Bot

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

[diff] [blame]

696

"A String",

697

],

698

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

699

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

yoshi-code-bot

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

[diff] [blame]

700

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

701

{ # A service account.

702

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

703

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

"A String",

],

},

],

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

709

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

710

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

711

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

712

},

713

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

714

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

715

},

716

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

717

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

718

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

719

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

720

},

721

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

722

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

723

},

724

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

yoshi-code-bot

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

[diff] [blame]

725

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

726

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

727

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

728

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

729

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

730

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

731

},

732

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

733

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

734

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

735

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

736

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

737

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

738

"A String",

739

],

740

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

741

"upcomingMaintenance": { # Upcoming Maintenance notification information. TODO(b/196881882) Deprecate this proto once it's fully migrated to be under proto ResourceStatus.UpcomingMaintenance. # [Output Only] Specifies upcoming maintenance for the instance.

Yoshi Automation Bot

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

[diff] [blame]

742

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

yoshi-code-bot

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

[diff] [blame]

743

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

744

"earliest": "A String",

745

"latest": "A String",

746

},

Yoshi Automation Bot

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

[diff] [blame]

747

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

748

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

749

},

750

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

751

},

752

],

Yoshi Automation Bot

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

[diff] [blame]

753

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

754

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

755

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

756

{

757

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

758

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

759

},

760

],

761

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

762

},

Bu Sun Kim

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

[diff] [blame]

763

},

Yoshi Automation Bot

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

[diff] [blame]

764

},

765

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

766

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

767

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

768

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

769

"A String",

770

],

771

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

772

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

773

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

774

{

775

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

776

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

777

},

778

],

779

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

780

},

781

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

786

<pre>Retrieves the next page of results.

787

788

Args:

789

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

790

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

791

792

Returns:

Bu Sun Kim

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

[diff] [blame]

793

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

Sai Cheemalapati

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

[diff] [blame]

794

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]

799

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

800

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

801

802

Args:

803

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

804

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

805

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

Dan O'Meara

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

[diff] [blame]

806

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

807

The object takes the form of:

808

809

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

810

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

811

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

812

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

813

"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-10-05 00:20:14 -0700

[diff] [blame]

814

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

815

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

816

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

817

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

818

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

819

},

Bu Sun Kim

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

[diff] [blame]

820

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

Bu Sun Kim

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

[diff] [blame]

821

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

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

[diff] [blame]

822

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

823

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame]

824

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

825

},

826

],

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame]

835

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

836

},

837

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

838

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

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

[diff] [blame]

839

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

840

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

841

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

842

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

843

"A String",

844

],

845

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

846

"A String",

847

],

Bu Sun Kim

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

[diff] [blame]

848

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

849

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

850

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

851

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

852

"A String",

853

],

854

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

855

"A String",

856

],

yoshi-code-bot

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

[diff] [blame]

857

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

858

"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-10-05 00:20:14 -0700

[diff] [blame]

859

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

860

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

861

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

862

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

863

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

864

},

yoshi-code-bot

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

[diff] [blame]

865

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

866

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

867

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

868

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

869

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

870

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

871

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

872

},

873

},

Bu Sun Kim

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

[diff] [blame]

874

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

875

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

876

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

877

"A String",

878

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

879

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Bu Sun Kim

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

[diff] [blame]

880

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

881

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

882

"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

883

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

884

{

885

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

886

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

887

},

888

],

889

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

890

{

891

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

892

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

893

},

894

],

895

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

896

{

897

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

898

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

899

},

900

],

901

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

902

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

903

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

Bu Sun Kim

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

[diff] [blame]

904

},

Bu Sun Kim

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

[diff] [blame]

905

},

yoshi-code-bot

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

[diff] [blame]

906

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

907

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

Bu Sun Kim

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

[diff] [blame]

908

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

909

"A String",

910

],

Sai Cheemalapati

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

[diff] [blame]

911

}

912

Dmitry Frenkel

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

[diff] [blame]

913

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]

914

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

915

x__xgafv: string, V1 error format.

916

Allowed values

917

1 - v1 error format

918

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

919

920

Returns:

921

An object of the form:

922

yoshi-code-bot

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

[diff] [blame]

923

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

924

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

925

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

926

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

927

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

928

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

929

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

Bu Sun Kim

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

[diff] [blame]

930

{

Yoshi Automation Bot

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

[diff] [blame]

931

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

932

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

933

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

Bu Sun Kim

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

[diff] [blame]

934

},

935

],

Yoshi Automation Bot

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

[diff] [blame]

936

},

937

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

938

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

939

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

940

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

941

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

942

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

yoshi-code-bot

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

[diff] [blame]

943

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

944

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

945

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

946

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

947

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

948

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

949

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

950

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

951

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

952

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

953

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

954

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

955

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

956

{

957

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

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

[diff] [blame]

958

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

959

{

960

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

961

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

962

},

963

],

964

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

965

},

966

],

967

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

968

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

972

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

Dan O'Meara

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

[diff] [blame]

973

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

974

975

Args:

976

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

977

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

978

body: object, The request body.

979

The object takes the form of:

980

yoshi-code-bot

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

[diff] [blame]

981

{ # 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 Automation Bot

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

[diff] [blame]

982

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

yoshi-code-bot

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

[diff] [blame]

983

"instance": { # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. # DEPRECATED: Please use instance_properties instead.

Dmitry Frenkel

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

[diff] [blame]

984

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

985

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

986

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

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

[diff] [blame]

987

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

Dmitry Frenkel

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

[diff] [blame]

988

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

yoshi-code-bot

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

[diff] [blame]

989

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

Dmitry Frenkel

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

[diff] [blame]

990

},

yoshi-code-bot

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

[diff] [blame]

991

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

[diff] [blame]

992

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

993

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

Bu Sun Kim

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

[diff] [blame]

994

},

Bu Sun Kim

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

[diff] [blame]

995

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

996

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

997

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

998

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

999

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

1000

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

1001

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

1002

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

1003

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

1004

"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-10-05 00:20:14 -0700

[diff] [blame]

1005

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1006

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1007

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1008

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1009

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

1010

},

Bu Sun Kim

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

[diff] [blame]

1011

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

Bu Sun Kim

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

[diff] [blame]

1012

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

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

[diff] [blame]

1013

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

1014

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame]

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

},

1017

],

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame]

1026

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

1027

},

1028

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1029

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

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

[diff] [blame]

1030

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

1031

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1032

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1033

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

1034

"A String",

1035

],

1036

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

1037

"A String",

1038

],

Bu Sun Kim

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

[diff] [blame]

1039

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

1040

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

1041

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

1042

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

1043

"A String",

1044

],

1045

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

1046

"A String",

1047

],

yoshi-code-bot

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

[diff] [blame]

1048

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

1049

"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-10-05 00:20:14 -0700

[diff] [blame]

1050

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1051

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1052

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1053

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1054

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

1055

},

yoshi-code-bot

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

[diff] [blame]

1056

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

1057

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

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1058

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1059

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1060

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1061

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1062

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

1063

},

1064

},

Bu Sun Kim

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

[diff] [blame]

1065

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

1066

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

1067

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

1068

"A String",

1069

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1070

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Bu Sun Kim

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

[diff] [blame]

1071

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

1072

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

1073

"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

1074

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

1075

{

1076

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

1077

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

1078

},

1079

],

1080

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

1081

{

1082

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

1083

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

1084

},

1085

],

1086

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

1087

{

1088

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

1089

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

1090

},

1091

],

1092

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

1093

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

1094

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

Bu Sun Kim

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

[diff] [blame]

1095

},

Bu Sun Kim

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

[diff] [blame]

1096

},

yoshi-code-bot

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

[diff] [blame]

1097

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

1098

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

Bu Sun Kim

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

[diff] [blame]

1099

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

1100

"A String",

1101

],

Sai Cheemalapati

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

[diff] [blame]

1102

},

1103

],

Bu Sun Kim

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

[diff] [blame]

1104

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

1105

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

Dan O'Meara

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

[diff] [blame]

1106

},

Bu Sun Kim

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

[diff] [blame]

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

},

1114

],

1115

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

1116

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

yoshi-code-bot

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

[diff] [blame]

1117

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1118

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1119

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1120

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1121

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1122

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

1123

},

1124

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

1125

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

1126

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

1127

"a_key": "A String",

1128

},

Bu Sun Kim

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

[diff] [blame]

1129

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

1130

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

1131

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

yoshi-code-bot

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

[diff] [blame]

1132

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

1133

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

1134

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

1135

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

1136

{ # Metadata

Bu Sun Kim

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

[diff] [blame]

1137

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

1138

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

1139

},

1140

],

1141

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

1142

},

1143

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

1144

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

1145

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

1146

{ # A network interface resource attached to an instance.

1147

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

1148

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

Bu Sun Kim

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

[diff] [blame]

1149

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

1150

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

Bu Sun Kim

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

[diff] [blame]

1151

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

1152

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

1153

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

1154

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

1155

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1156

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

Bu Sun Kim

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

[diff] [blame]

1157

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1158

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

Bu Sun Kim

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

[diff] [blame]

1159

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

1160

},

1161

],

1162

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

1163

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

1164

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

1165

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

1166

},

1167

],

yoshi-code-bot

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

[diff] [blame]

1168

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

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

1175

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

1176

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

1177

"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-11-16 11:05:03 -0700

[diff] [blame]

1178

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1179

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

Bu Sun Kim

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

[diff] [blame]

1180

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

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1181

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

Bu Sun Kim

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

[diff] [blame]

1182

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

1183

},

1184

],

yoshi-code-bot

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

[diff] [blame]

1185

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

1186

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

1187

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

1188

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

1189

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

1190

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

Bu Sun Kim

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

[diff] [blame]

1191

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

1192

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

yoshi-code-bot

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

[diff] [blame]

1193

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

yoshi-code-bot

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

[diff] [blame]

1194

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1195

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1196

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

1197

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1198

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

1199

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1200

},

1201

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1202

"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]

1203

},

1204

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1205

"networkPerformanceConfig": {

1206

"externalIpEgressBandwidthTier": "A String",

1207

"totalEgressBandwidthTier": "A String",

1208

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1209

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1210

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1211

"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]

1212

"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]

1213

"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]

1214

"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]

1215

"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.

1220

"A String",

1221

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1222

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

1223

"scheduling": {

1224

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

1225

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1226

"upcomingMaintenance": {

1227

"canReschedule": True or False, # Indicates if the maintenance can be customer triggered. See go/sf-ctm-design for more details

1228

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1229

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1230

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1231

"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]

1232

"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-03-02 11:49:08 -0800

[diff] [blame]

1233

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1234

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

1235

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1236

"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-08-31 00:28:27 -0700

[diff] [blame]

1237

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1238

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1239

"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]

1240

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

1241

"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]

1242

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1243

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1244

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1245

"key": "A String", # Corresponds to the label key of Node resource.

1246

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1247

"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]

1253

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1254

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1255

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1256

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

1257

"A String",

1258

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1259

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1260

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1261

"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]

1262

{ # A service account.

1263

"email": "A String", # Email address of the service account.

1264

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1270

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1271

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1272

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1273

},

1274

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1275

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1276

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1277

"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]

1278

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1279

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1280

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1281

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1282

"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]

1283

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1284

},

1285

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1286

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1287

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1288

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1289

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1290

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1291

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1292

},

1293

"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]

1294

"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]

1295

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1296

"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]

1297

"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]

1298

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

1299

"A String",

1300

],

1301

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1302

"upcomingMaintenance": { # Upcoming Maintenance notification information. TODO(b/196881882) Deprecate this proto once it's fully migrated to be under proto ResourceStatus.UpcomingMaintenance. # [Output Only] Specifies upcoming maintenance for the instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1303

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1304

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

1305

"earliest": "A String",

1306

"latest": "A String",

1307

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1308

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1309

"type": "A String", # Defines the type of maintenance.

1310

},

1311

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1312

},

1313

"instanceProperties": { # The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1314

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1315

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1316

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1317

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1318

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1319

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1320

},

1321

"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.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1322

"confidentialInstanceConfig": { # A set of Confidential Instance options. # Specifies the Confidential Instance options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1323

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1324

},

1325

"description": "A String", # An optional text description for the instances that are created from these properties.

1326

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

1327

{ # An instance-attached disk resource.

1328

"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).

1329

"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]

1330

"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.

1331

"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-10-05 00:20:14 -0700

[diff] [blame]

1332

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1333

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1334

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1335

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1336

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1337

},

1338

"diskSizeGb": "A String", # The size of the disk in GB.

1339

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1340

"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]

1341

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1342

"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]

1343

},

1344

],

1345

"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]

1346

"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]

1347

"description": "A String", # An optional description. Provide this property when creating the disk.

1348

"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.

1349

"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]

1350

"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]

1351

"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]

1352

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1353

"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]

1354

},

1355

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1356

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1357

"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.

1358

"a_key": "A String",

1359

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1360

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

1361

"A String",

1362

],

1363

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

1364

"A String",

1365

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1366

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1367

"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]

1368

"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]

1369

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1370

"A String",

1371

],

1372

"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.

1373

"A String",

1374

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1375

"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.

1376

"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-10-05 00:20:14 -0700

[diff] [blame]

1377

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1378

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1379

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1380

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1381

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1382

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1383

"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]

1384

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1385

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1386

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1387

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1388

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1389

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1390

},

1391

},

1392

"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.

1393

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1394

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1395

"A String",

1396

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1397

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1398

"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.

1399

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1400

"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

1401

"dbs": [ # The Key Database (db).

1402

{

1403

"content": "A String", # The raw content in the secure keys file.

1404

"fileType": "A String", # The file type of source file.

1405

},

1406

],

1407

"dbxs": [ # The forbidden key database (dbx).

1408

{

1409

"content": "A String", # The raw content in the secure keys file.

1410

"fileType": "A String", # The file type of source file.

1411

},

1412

],

1413

"keks": [ # The Key Exchange Key (KEK).

1414

{

1415

"content": "A String", # The raw content in the secure keys file.

1416

"fileType": "A String", # The file type of source file.

1417

},

1418

],

1419

"pk": { # The Platform Key (PK).

1420

"content": "A String", # The raw content in the secure keys file.

1421

"fileType": "A String", # The file type of source file.

1422

},

1423

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1424

"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]

1425

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

1426

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

"A String",

],

},

],

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1431

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1432

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1433

},

1434

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

1435

{ # A specification of the type and number of accelerator cards attached to the instance.

1436

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1437

"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.

1438

},

1439

],

1440

"labels": { # Labels to apply to instances that are created from these properties.

1441

"a_key": "A String",

1442

},

1443

"machineType": "A String", # The machine type to use for instances that are created from these properties.

1444

"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]

1445

"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]

1446

"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]

1447

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1448

"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.

1449

"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).

1450

},

1451

],

1452

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1453

},

1454

"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.

1455

"networkInterfaces": [ # An array of network access configurations for this interface.

1456

{ # A network interface resource attached to an instance.

1457

"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.

1458

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1459

"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.

1460

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1461

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1462

"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.

1463

"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]

1464

"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]

1465

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1466

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1467

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1468

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1469

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1470

},

1471

],

1472

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1473

{ # An alias IP range attached to an instance's network interface.

1474

"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).

1475

"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.

1476

},

1477

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1478

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1479

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

1480

"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.

1481

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1482

"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.

1483

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1484

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1485

"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.

1486

"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]

1487

"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]

1488

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1489

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1490

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1491

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1492

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1493

},

1494

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1495

"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]

1496

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1497

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1498

"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]

1499

"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]

1500

"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.

1501

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

1502

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1503

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1504

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

1505

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1506

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

1507

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1508

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

1509

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

1510

},

1511

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1512

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1513

},

1514

],

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1515

"networkPerformanceConfig": {

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1516

"externalIpEgressBandwidthTier": "A String",

1517

"totalEgressBandwidthTier": "A String",

1518

},

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1519

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.(will be deprecated soon)

1520

"privateIpv6GoogleAccess": "A String", # The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default.

1521

"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]

1522

"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]

1523

"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]

1524

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1525

"A String",

1526

],

1527

},

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1528

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1529

"A String",

1530

],

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1531

"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]

1532

"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-03-02 11:49:08 -0800

[diff] [blame]

1533

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

1534

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

1535

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1536

"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-08-31 00:28:27 -0700

[diff] [blame]

1537

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1538

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

1539

"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]

1540

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

1541

"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]

1542

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1543

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1544

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1545

"key": "A String", # Corresponds to the label key of Node resource.

1546

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1547

"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.

1553

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

1554

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1555

},

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1556

"secureTags": [ # [Input Only] Secure tags to apply to this instance. Maximum number of secure tags allowed is 50.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1557

"A String",

1558

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1559

"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.

1560

{ # A service account.

1561

"email": "A String", # Email address of the service account.

1562

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

1567

"shieldedInstanceConfig": { # A set of Shielded Instance options.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1568

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1569

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1570

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1571

},

1572

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

1573

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

1574

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

1575

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

1576

},

1577

"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]

1578

"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]

1579

"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]

1584

"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.

1585

"locations": { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1586

"a_key": {

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1587

"preference": "A String", # Preference for a given location: ALLOW or DENY.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1588

},

1589

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

1590

"targetShape": "A String", # Strategy for distributing VMs across zones in a region.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1591

},

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1592

"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]

1593

"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]

1594

"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.

1595

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

1596

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

1597

},

1598

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1599

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1600

}

1601

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1602

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).

1603

x__xgafv: string, V1 error format.

1604

Allowed values

1605

1 - v1 error format

1606

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1607

1608

Returns:

1609

An object of the form:

1610

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1611

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

1612

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1613

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1614

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1615

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1616

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1617

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1618

{

1619

"code": "A String", # [Output Only] The error type identifier for this error.

1620

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1621

"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`.

1626

"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.

1627

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1628

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1629

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1630

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1631

"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]

1632

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1633

"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.

1634

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1635

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1636

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1637

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1638

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1639

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1640

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1641

"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.

1642

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1643

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1644

{

1645

"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]

1646

"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]

1647

{

1648

"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).

1649

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1650

},

1651

],

1652

"message": "A String", # [Output Only] A human-readable description of the warning code.

1653

},

1654

],

1655

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="close">close()</code>

1661

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1665

<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]

1666

<pre>Deletes the specified Instance resource. For more information, see Deleting an instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1667

1668

Args:

1669

project: string, Project ID for this request. (required)

1670

zone: string, The name of the zone for this request. (required)

1671

instance: string, Name of the instance resource to delete. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1672

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).

1673

x__xgafv: string, V1 error format.

1674

Allowed values

1675

1 - v1 error format

1676

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1677

1678

Returns:

1679

An object of the form:

1680

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1681

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

1682

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1683

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1684

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1685

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1686

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1687

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1688

{

1689

"code": "A String", # [Output Only] The error type identifier for this error.

1690

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1691

"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`.

1696

"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.

1697

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1698

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1699

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1700

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1701

"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]

1702

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1703

"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.

1704

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1705

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1706

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1707

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1708

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1709

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1710

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1711

"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.

1712

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1713

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1714

{

1715

"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]

1716

"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]

1717

{

1718

"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).

1719

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1720

},

1721

],

1722

"message": "A String", # [Output Only] A human-readable description of the warning code.

1723

},

1724

],

1725

"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]

1730

<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1731

<pre>Deletes an access config from an instance's network interface.

1732

1733

Args:

1734

project: string, Project ID for this request. (required)

1735

zone: string, The name of the zone for this request. (required)

1736

instance: string, The instance name for this request. (required)

1737

accessConfig: string, The name of the access config to delete. (required)

1738

networkInterface: string, The name of the network interface. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1739

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).

1740

x__xgafv: string, V1 error format.

1741

Allowed values

1742

1 - v1 error format

1743

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1744

1745

Returns:

1746

An object of the form:

1747

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1748

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

1749

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1750

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1751

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1752

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1753

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1754

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1755

{

1756

"code": "A String", # [Output Only] The error type identifier for this error.

1757

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1758

"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`.

1763

"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.

1764

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1765

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1766

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1767

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1768

"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]

1769

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1770

"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.

1771

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1772

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1773

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1774

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1775

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1776

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1777

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1778

"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.

1779

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1780

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1781

{

1782

"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]

1783

"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]

1784

{

1785

"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).

1786

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1787

},

1788

],

1789

"message": "A String", # [Output Only] A human-readable description of the warning code.

1790

},

1791

],

1792

"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]

1797

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1798

<pre>Detaches a disk from an instance.

1799

1800

Args:

1801

project: string, Project ID for this request. (required)

1802

zone: string, The name of the zone for this request. (required)

1803

instance: string, Instance name for this request. (required)

1804

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]

1805

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).

1806

x__xgafv: string, V1 error format.

1807

Allowed values

1808

1 - v1 error format

1809

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1810

1811

Returns:

1812

An object of the form:

1813

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1814

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

1815

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1816

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1817

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1818

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1819

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1820

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1821

{

1822

"code": "A String", # [Output Only] The error type identifier for this error.

1823

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1824

"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`.

1829

"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.

1830

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1831

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1832

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1833

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1834

"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]

1835

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1836

"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.

1837

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1838

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1839

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1840

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1841

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1842

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1843

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1844

"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.

1845

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1846

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1847

{

1848

"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]

1849

"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]

1850

{

1851

"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).

1852

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1853

},

1854

],

1855

"message": "A String", # [Output Only] A human-readable description of the warning code.

1856

},

1857

],

1858

"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]

1863

<code class="details" id="get">get(project, zone, instance, x__xgafv=None)</code>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1864

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

1865

1866

Args:

1867

project: string, Project ID for this request. (required)

1868

zone: string, The name of the zone for this request. (required)

1869

instance: string, Name of the instance resource to return. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1870

x__xgafv: string, V1 error format.

1871

Allowed values

1872

1 - v1 error format

1873

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1874

1875

Returns:

1876

An object of the form:

1877

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1878

{ # 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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1879

"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.

1880

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1881

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

1882

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1883

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1884

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1885

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1886

"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]

1887

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1888

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1889

},

1890

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1891

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1892

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1893

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1894

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

1895

{ # An instance-attached disk resource.

1896

"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).

1897

"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]

1898

"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.

1899

"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-10-05 00:20:14 -0700

[diff] [blame]

1900

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1901

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1902

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1903

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1904

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1905

},

1906

"diskSizeGb": "A String", # The size of the disk in GB.

1907

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1908

"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]

1909

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1910

"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]

1911

},

1912

],

1913

"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]

1914

"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]

1915

"description": "A String", # An optional description. Provide this property when creating the disk.

1916

"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.

1917

"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]

1918

"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]

1919

"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]

1920

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1921

"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]

1922

},

1923

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1924

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1925

"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.

1926

"a_key": "A String",

1927

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

1928

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

1929

"A String",

1930

],

1931

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

1932

"A String",

1933

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1934

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

1935

"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]

1936

"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]

1937

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

1938

"A String",

1939

],

1940

"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.

1941

"A String",

1942

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1943

"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.

1944

"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-10-05 00:20:14 -0700

[diff] [blame]

1945

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1946

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1947

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1948

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1949

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1950

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1951

"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]

1952

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

1953

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

1954

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

1955

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

1956

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

1957

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1958

},

1959

},

1960

"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.

1961

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1962

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1963

"A String",

1964

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

1965

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1966

"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.

1967

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

1968

"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

1969

"dbs": [ # The Key Database (db).

1970

{

1971

"content": "A String", # The raw content in the secure keys file.

1972

"fileType": "A String", # The file type of source file.

1973

},

1974

],

1975

"dbxs": [ # The forbidden key database (dbx).

1976

{

1977

"content": "A String", # The raw content in the secure keys file.

1978

"fileType": "A String", # The file type of source file.

1979

},

1980

],

1981

"keks": [ # The Key Exchange Key (KEK).

1982

{

1983

"content": "A String", # The raw content in the secure keys file.

1984

"fileType": "A String", # The file type of source file.

1985

},

1986

],

1987

"pk": { # The Platform Key (PK).

1988

"content": "A String", # The raw content in the secure keys file.

1989

"fileType": "A String", # The file type of source file.

1990

},

1991

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

1992

"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]

1993

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

1994

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

"A String",

],

},

],

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2000

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2001

},

2002

"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]

2003

"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]

2004

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2005

{ # A specification of the type and number of accelerator cards attached to the instance.

2006

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2007

"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.

2008

},

2009

],

2010

"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.

2011

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2012

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

2013

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

2014

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

2015

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

2016

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

2017

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2018

},

2019

"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]

2020

"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]

2021

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2022

"a_key": "A String",

2023

},

2024

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2025

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2026

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2027

"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]

2028

"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]

2029

"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]

2030

"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]

2031

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2032

"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.

2033

"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).

2034

},

2035

],

2036

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2037

},

2038

"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".

2039

"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.

2040

"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.

2041

{ # A network interface resource attached to an instance.

2042

"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.

2043

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2044

"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.

2045

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2046

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2047

"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.

2048

"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]

2049

"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]

2050

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2051

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2052

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2053

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2054

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2055

},

2056

],

2057

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2058

{ # An alias IP range attached to an instance's network interface.

2059

"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).

2060

"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.

2061

},

2062

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2063

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2064

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

2065

"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.

2066

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2067

"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.

2068

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2069

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2070

"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.

2071

"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]

2072

"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]

2073

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2074

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2075

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2076

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2077

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2078

},

2079

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2080

"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]

2081

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2082

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2083

"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]

2084

"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]

2085

"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.

2086

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

2087

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2088

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2089

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

2090

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2091

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

2092

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2093

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

2094

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

2095

},

2096

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2097

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2098

},

2099

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2100

"networkPerformanceConfig": {

2101

"externalIpEgressBandwidthTier": "A String",

2102

"totalEgressBandwidthTier": "A String",

2103

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2104

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

2105

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2106

"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]

2107

"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]

2108

"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]

2109

"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]

2110

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

2115

"A String",

2116

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2117

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

2118

"scheduling": {

2119

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

2120

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

2121

"upcomingMaintenance": {

2122

"canReschedule": True or False, # Indicates if the maintenance can be customer triggered. See go/sf-ctm-design for more details

2123

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2124

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2125

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2126

"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]

2127

"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-03-02 11:49:08 -0800

[diff] [blame]

2128

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

2129

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

2130

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2131

"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-08-31 00:28:27 -0700

[diff] [blame]

2132

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2133

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

2134

"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]

2135

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2136

"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]

2137

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2138

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2139

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2140

"key": "A String", # Corresponds to the label key of Node resource.

2141

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2142

"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.

2148

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2149

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2150

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2151

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2152

"A String",

2153

],

2154

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2155

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2156

"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]

2157

{ # A service account.

2158

"email": "A String", # Email address of the service account.

2159

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2165

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2166

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2167

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2168

},

2169

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2170

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2171

},

2172

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

2173

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2174

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2175

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2176

},

2177

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

2178

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2179

},

2180

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2181

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

2182

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

2183

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

2184

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

2185

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

2186

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2187

},

2188

"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]

2189

"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]

2190

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2191

"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]

2192

"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]

2193

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

2194

"A String",

2195

],

2196

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

2197

"upcomingMaintenance": { # Upcoming Maintenance notification information. TODO(b/196881882) Deprecate this proto once it's fully migrated to be under proto ResourceStatus.UpcomingMaintenance. # [Output Only] Specifies upcoming maintenance for the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2198

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2199

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

2200

"earliest": "A String",

2201

"latest": "A String",

2202

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2203

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

2204

"type": "A String", # Defines the type of maintenance.

2205

},

2206

"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.

2207

}</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]

2211

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2212

<pre>Returns effective firewalls applied to an interface of the instance.

2213

2214

Args:

2215

project: string, Project ID for this request. (required)

2216

zone: string, The name of the zone for this request. (required)

2217

instance: string, Name of the instance scoping this request. (required)

2218

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]

2219

x__xgafv: string, V1 error format.

2220

Allowed values

2221

1 - v1 error format

2222

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2223

2224

Returns:

2225

An object of the form:

2226

2227

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2228

"firewallPolicys": [ # Effective firewalls from firewall policies.

2229

{

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2230

"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]

2231

"name": "A String", # [Output Only] The name of the firewall policy.

2232

"rules": [ # The rules that apply to the network.

2233

{ # 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).

2234

"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]

2235

"description": "A String", # An optional description for this resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2236

"direction": "A String", # The direction in which this rule applies.

2237

"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.

2238

"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.

2239

"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]

2240

"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-code-bot

312da31

2021-09-21 00:22:28 -0700

[diff] [blame]

2241

"destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.

2242

"A String",

2243

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

2244

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2245

"A String",

2246

],

2247

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

2248

{

2249

"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]

2250

"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",

],

},

],

yoshi-code-bot

312da31

2021-09-21 00:22:28 -0700

[diff] [blame]

2255

"srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.

2256

"A String",

2257

],

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

2258

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2259

"A String",

2260

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2261

"srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.

2262

{

2263

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

2264

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

2265

},

2266

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2267

},

2268

"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.

2269

"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]

2270

"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]

2271

"A String",

2272

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2273

"targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.

2274

{

2275

"name": "A String", # Name of the secure tag, created with TagManager's TagValue API.

2276

"state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.

2277

},

2278

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2279

"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]

2284

"shortName": "A String", # [Output Only] The short name of the firewall policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2285

"type": "A String", # [Output Only] The type of the firewall policy.

2286

},

2287

],

2288

"firewalls": [ # Effective firewalls on the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2289

{ # 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]

2290

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

2291

{

2292

"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]

2293

"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.

2299

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

2300

{

2301

"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]

2302

"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.

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

2308

"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. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2309

"A String",

2310

],

2311

"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.

2312

"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.

2313

"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.

2314

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2315

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

2316

"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.

2317

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

2318

"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.

2319

},

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2320

"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]

2321

"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]

2322

"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`.

2323

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2324

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

2325

"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. Both IPv4 and IPv6 are supported.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2326

"A String",

2327

],

2328

"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.

2329

"A String",

2330

],

2331

"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.

2332

"A String",

2333

],

2334

"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.

2335

"A String",

2336

],

2337

"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.

2343

{ # A pruned SecurityPolicy containing ID and any applicable firewall rules.

2344

"id": "A String", # The unique identifier for the security policy. This identifier is defined by the server.

2345

"rules": [ # The rules that apply to the network.

2346

{ # 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]

2347

"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]

2348

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2349

"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]

2350

"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-03-31 13:33:30 -0700

[diff] [blame]

2351

"headerAction": { # Optional, additional actions that are performed on headers.

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

2352

"requestHeadersToAdds": [ # The list of request headers to add or overwrite if they're already present.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2353

{

2354

"headerName": "A String", # The name of the header to set.

2355

"headerValue": "A String", # The value to set the named header to.

2356

},

2357

],

2358

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2359

"kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules

2360

"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.

2361

"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]

2362

"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]

2363

"A String",

2364

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2365

"destPorts": [ # 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]

2366

{

2367

"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]

2368

"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-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2373

"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

2021-01-15 07:10:04 -0800

[diff] [blame]

2374

{

2375

"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]

2376

"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

2021-01-15 07:10:04 -0800

[diff] [blame]

2377

"A String",

2378

],

2379

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2380

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2381

"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]

2382

"A String",

2383

],

2384

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2385

"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]

2386

"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.

2387

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2388

"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.

2389

"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.

2390

},

2391

"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]

2392

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2393

"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]

2394

"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.

2395

"rateLimitOptions": { # Must be specified if the action is "rate_based_ban" or "throttle". Cannot be specified for any other actions.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2396

"banDurationSec": 42, # Can only be specified if the action for the rule is "rate_based_ban". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.

2397

"banThreshold": { # Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2398

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

2399

"intervalSec": 42, # Interval over which the threshold is computed.

2400

},

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

2401

"conformAction": "A String", # Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2402

"enforceOnKey": "A String", # Determines the key to enforce the rate_limit_threshold on. Possible values are: "ALL" -- A single rate limit threshold is applied to all the requests matching this rule. This is the default value if this field 'enforce_on_key' is not configured. "ALL_IPS" -- This definition, equivalent to "ALL", has been depprecated. "IP" -- The source IP address of the request is the key. Each IP has this limit enforced separately. "HTTP_HEADER" -- The value of the HTTP header whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to "ALL". "XFF_IP" -- The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key type defaults to "ALL".

2403

"enforceOnKeyName": "A String", # Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2404

"exceedAction": "A String", # When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502.

2405

"rateLimitThreshold": { # Threshold at which to begin ratelimiting.

2406

"count": 42, # Number of HTTP(S) requests for calculating the threshold.

2407

"intervalSec": 42, # Interval over which the threshold is computed.

2408

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2409

},

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2410

"redirectOptions": { # Parameters defining the redirect action. Cannot be specified for any other actions.

2411

"target": "A String", # Target for the redirect action. This is required if the type is EXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.

2412

"type": "A String", # Type of the redirect action.

2413

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2414

"redirectTarget": "A String", # This must be specified for redirect actions. Cannot be specified for any other actions.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2415

"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.

2416

"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]

2417

"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]

2418

"A String",

2419

],

2420

"targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.

2421

"A String",

2422

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2423

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

},

],

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2431

<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]

2432

<pre>Returns the specified guest attributes entry.

2433

2434

Args:

2435

project: string, Project ID for this request. (required)

2436

zone: string, The name of the zone for this request. (required)

2437

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2438

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2439

variableKey: string, Specifies the key for the guest attributes entry.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2440

x__xgafv: string, V1 error format.

2441

Allowed values

2442

1 - v1 error format

2443

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2444

2445

Returns:

2446

An object of the form:

2447

2448

{ # A guest attributes entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2449

"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]

2450

"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]

2451

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

2452

"items": [

2453

{ # A guest attributes namespace/key/value entry.

2454

"key": "A String", # Key for the guest attribute entry.

2455

"namespace": "A String", # Namespace for the guest attribute entry.

2456

"value": "A String", # Value for the guest attribute entry.

},

],

},

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2461

"variableKey": "A String", # The key to search for.

2462

"variableValue": "A String", # [Output Only] The value found for the requested key.

2463

}</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]

2467

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2468

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

2469

2470

Args:

2471

project: string, Project ID for this request. (required)

2472

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2473

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2474

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2475

x__xgafv: string, V1 error format.

2476

Allowed values

2477

1 - v1 error format

2478

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2479

2480

Returns:

2481

An object of the form:

2482

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2483

{ # 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]

2484

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2485

{ # 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]

2486

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2487

{ # 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.

2488

"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]

2489

"A String",

2490

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2491

"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]

2492

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2493

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2494

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2495

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2496

"A String",

2497

],

2498

"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.

2499

},

2500

],

2501

"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.

2502

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2503

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

2504

"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]

2505

"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.

2506

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2507

"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.

2508

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2509

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2510

"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]

2511

"A String",

2512

],

2513

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2514

},

2515

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2516

"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.

2517

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

2518

"rules": [ # This is deprecated and has no effect. Do not use.

2519

{ # This is deprecated and has no effect. Do not use.

2520

"action": "A String", # This is deprecated and has no effect. Do not use.

2521

"conditions": [ # This is deprecated and has no effect. Do not use.

2522

{ # This is deprecated and has no effect. Do not use.

2523

"iam": "A String", # This is deprecated and has no effect. Do not use.

2524

"op": "A String", # This is deprecated and has no effect. Do not use.

2525

"svc": "A String", # This is deprecated and has no effect. Do not use.

2526

"sys": "A String", # This is deprecated and has no effect. Do not use.

2527

"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]

2532

"description": "A String", # This is deprecated and has no effect. Do not use.

2533

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2534

"A String",

2535

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2536

"logConfigs": [ # This is deprecated and has no effect. Do not use.

2537

{ # This is deprecated and has no effect. Do not use.

2538

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2539

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2540

"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]

2541

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2542

"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]

2543

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2544

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2545

"customFields": [ # This is deprecated and has no effect. Do not use.

2546

{ # This is deprecated and has no effect. Do not use.

2547

"name": "A String", # This is deprecated and has no effect. Do not use.

2548

"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]

2549

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2550

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2551

"field": "A String", # This is deprecated and has no effect. Do not use.

2552

"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]

2553

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2554

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2555

"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]

2556

},

2557

},

2558

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2559

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2560

"A String",

2561

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2562

"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]

2567

"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]

2568

}</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]

2572

<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]

2573

<pre>Returns the screenshot from the specified instance.

2574

2575

Args:

2576

project: string, Project ID for this request. (required)

2577

zone: string, The name of the zone for this request. (required)

2578

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2579

x__xgafv: string, V1 error format.

2580

Allowed values

2581

1 - v1 error format

2582

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2583

2584

Returns:

2585

An object of the form:

2586

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2587

{ # An instance's screenshot.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2588

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

2589

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

2590

}</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]

2594

<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]

2595

<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]

2596

2597

Args:

2598

project: string, Project ID for this request. (required)

2599

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2600

instance: string, Name of the instance for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2601

port: integer, Specifies which COM or serial port to retrieve data from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2602

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.

2603

x__xgafv: string, V1 error format.

2604

Allowed values

2605

1 - v1 error format

2606

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2607

2608

Returns:

2609

An object of the form:

2610

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2611

{ # An instance serial console output.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2612

"contents": "A String", # [Output Only] The contents of the console output.

2613

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

2614

"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.

2615

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2616

"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.

2617

}</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]

2621

<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]

2622

<pre>Returns the Shielded Instance Identity of an instance

2623

2624

Args:

2625

project: string, Project ID for this request. (required)

2626

zone: string, The name of the zone for this request. (required)

2627

instance: string, Name or id of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2628

x__xgafv: string, V1 error format.

2629

Allowed values

2630

1 - v1 error format

2631

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2632

2633

Returns:

2634

An object of the form:

2635

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2636

{ # A Shielded Instance Identity.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

2637

"eccP256EncryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the ECC P256 algorithm issued to the Shielded Instance's vTPM.

2638

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2639

"ekPub": "A String", # A PEM-encoded public key.

2640

},

2641

"eccP256SigningKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the ECC P256 algorithm issued to the Shielded Instance's vTPM.

2642

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2643

"ekPub": "A String", # A PEM-encoded public key.

2644

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2645

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2646

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2647

"ekPub": "A String", # A PEM-encoded public key.

2648

},

2649

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

2650

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

2651

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2652

"ekPub": "A String", # A PEM-encoded public key.

2653

},

2654

}</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]

2658

<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]

2659

<pre>Returns the Shielded VM Identity of an instance

2660

2661

Args:

2662

project: string, Project ID for this request. (required)

2663

zone: string, The name of the zone for this request. (required)

2664

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2665

x__xgafv: string, V1 error format.

2666

Allowed values

2667

1 - v1 error format

2668

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2669

2670

Returns:

2671

An object of the form:

2672

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2673

{ # A Shielded VM Identity.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2674

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) issued to the Shielded VM's vTPM.

2675

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2676

"ekPub": "A String", # A PEM-encoded public key.

2677

},

2678

"kind": "compute#shieldedVmIdentity", # [Output Only] Type of the resource. Always compute#shieldedVmIdentity for shielded VM identity entry.

2679

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) issued to the Shielded VM's vTPM.

2680

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

2681

"ekPub": "A String", # A PEM-encoded public key.

2682

},

2683

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

2687

<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]

2688

<pre>Creates an instance resource in the specified project using the data included in the request.

2689

2690

Args:

2691

project: string, Project ID for this request. (required)

2692

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2693

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2694

The object takes the form of:

2695

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2696

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2697

"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.

2698

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

2699

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2700

"numaNodeCount": 42, # The number of vNUMA nodes.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2701

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2702

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2703

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2704

"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-05-20 12:08:20 -0700

[diff] [blame]

2705

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2706

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2707

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2708

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2709

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2710

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2711

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2712

"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]

2713

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2714

"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).

2715

"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]

2716

"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.

2717

"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-10-05 00:20:14 -0700

[diff] [blame]

2718

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

2719

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

2720

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

2721

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

2722

"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]

2723

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2724

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2725

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2726

"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]

2727

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2728

"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]

2729

},

2730

],

2731

"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]

2732

"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]

2733

"description": "A String", # An optional description. Provide this property when creating the disk.

2734

"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.

2735

"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]

2736

"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]

2737

"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]

2738

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2739

"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]

2740

},

2741

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2742

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2743

"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.

2744

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2745

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

2746

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

2747

"A String",

2748

],

2749

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

2750

"A String",

2751

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2752

"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]

2753

"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]

2754

"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]

2755

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

2756

"A String",

2757

],

2758

"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.

2759

"A String",

2760

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2761

"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.

2762

"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-10-05 00:20:14 -0700

[diff] [blame]

2763

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

2764

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

2765

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

2766

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

2767

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2768

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2769

"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]

2770

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

2771

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

2772

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

2773

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

2774

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

2775

"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]

2776

},

2777

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2778

"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.

2779

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2780

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2781

"A String",

2782

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

2783

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2784

"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.

2785

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

2786

"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

2787

"dbs": [ # The Key Database (db).

2788

{

2789

"content": "A String", # The raw content in the secure keys file.

2790

"fileType": "A String", # The file type of source file.

2791

},

2792

],

2793

"dbxs": [ # The forbidden key database (dbx).

2794

{

2795

"content": "A String", # The raw content in the secure keys file.

2796

"fileType": "A String", # The file type of source file.

2797

},

2798

],

2799

"keks": [ # The Key Exchange Key (KEK).

2800

{

2801

"content": "A String", # The raw content in the secure keys file.

2802

"fileType": "A String", # The file type of source file.

2803

},

2804

],

2805

"pk": { # The Platform Key (PK).

2806

"content": "A String", # The raw content in the secure keys file.

2807

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2808

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2809

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2810

"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]

2811

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2812

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

2813

"A String",

2814

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2815

},

2816

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2817

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2818

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2819

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2820

"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]

2821

"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]

2822

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2823

{ # A specification of the type and number of accelerator cards attached to the instance.

2824

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2825

"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.

2826

},

2827

],

2828

"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.

2829

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2830

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

2831

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

2832

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

2833

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

2834

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

2835

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2836

},

2837

"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]

2838

"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]

2839

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2840

"a_key": "A String",

2841

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2842

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2843

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2844

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2845

"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]

2846

"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]

2847

"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]

2848

"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]

2849

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2850

"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.

2851

"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).

2852

},

2853

],

2854

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2855

},

2856

"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".

2857

"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.

2858

"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.

2859

{ # A network interface resource attached to an instance.

2860

"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.

2861

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2862

"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.

2863

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2864

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2865

"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.

2866

"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]

2867

"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]

2868

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2869

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2870

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2871

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2872

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2873

},

2874

],

2875

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2876

{ # An alias IP range attached to an instance's network interface.

2877

"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).

2878

"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.

2879

},

2880

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2881

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2882

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

2883

"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.

2884

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2885

"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.

2886

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2887

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2888

"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.

2889

"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]

2890

"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-11-16 11:05:03 -0700

[diff] [blame]

2891

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2892

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2893

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

2894

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2895

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2896

},

2897

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2898

"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]

2899

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2900

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2901

"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]

2902

"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]

2903

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2904

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

2905

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2906

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2907

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

2908

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2909

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

2910

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2911

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

2912

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

2913

},

2914

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2915

"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]

2916

},

2917

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2918

"networkPerformanceConfig": {

2919

"externalIpEgressBandwidthTier": "A String",

2920

"totalEgressBandwidthTier": "A String",

2921

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2922

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2923

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2924

"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]

2925

"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]

2926

"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]

2927

"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]

2928

"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.

2933

"A String",

2934

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2935

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

2936

"scheduling": {

2937

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

2938

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

2939

"upcomingMaintenance": {

2940

"canReschedule": True or False, # Indicates if the maintenance can be customer triggered. See go/sf-ctm-design for more details

2941

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2942

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2943

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2944

"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]

2945

"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-03-02 11:49:08 -0800

[diff] [blame]

2946

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

2947

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

2948

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

2949

"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-08-31 00:28:27 -0700

[diff] [blame]

2950

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2951

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

2952

"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]

2953

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

2954

"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]

2955

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2956

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2957

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2958

"key": "A String", # Corresponds to the label key of Node resource.

2959

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2960

"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]

2966

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

2967

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2968

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2969

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

2970

"A String",

2971

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2972

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2973

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

2974

"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]

2975

{ # A service account.

2976

"email": "A String", # Email address of the service account.

2977

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2983

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2984

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2985

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2986

},

2987

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2988

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2989

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2990

"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]

2991

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

2992

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

2993

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

2994

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2995

"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]

2996

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2997

},

2998

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2999

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3000

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3001

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3002

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3003

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3004

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3005

},

3006

"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]

3007

"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]

3008

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3009

"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]

3010

"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]

3011

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

3012

"A String",

3013

],

3014

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3015

"upcomingMaintenance": { # Upcoming Maintenance notification information. TODO(b/196881882) Deprecate this proto once it's fully migrated to be under proto ResourceStatus.UpcomingMaintenance. # [Output Only] Specifies upcoming maintenance for the instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3016

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3017

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

3018

"earliest": "A String",

3019

"latest": "A String",

3020

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3021

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3022

"type": "A String", # Defines the type of maintenance.

3023

},

3024

"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]

3025

}

3026

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3027

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).

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3028

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

3029

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

3030

x__xgafv: string, V1 error format.

3031

Allowed values

3032

1 - v1 error format

3033

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3034

3035

Returns:

3036

An object of the form:

3037

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3038

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

3039

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3040

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3041

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3042

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3043

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3044

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3045

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3046

"code": "A String", # [Output Only] The error type identifier for this error.

3047

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3048

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3049

},

3050

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3051

},

3052

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3053

"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.

3054

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3055

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3056

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3057

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3058

"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]

3059

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3060

"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.

3061

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3062

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3063

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3064

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3065

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3066

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3067

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3068

"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.

3069

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3070

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3071

{

3072

"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]

3073

"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]

3074

{

3075

"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).

3076

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3077

},

3078

],

3079

"message": "A String", # [Output Only] A human-readable description of the warning code.

3080

},

3081

],

3082

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3083

}</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]

3087

<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]

3088

<pre>Retrieves the list of instances contained within the specified zone.

3089

3090

Args:

3091

project: string, Project ID for this request. (required)

3092

zone: string, The name of the zone for this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3093

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]

3094

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]

3095

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]

3096

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]

3097

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]

3098

x__xgafv: string, V1 error format.

3099

Allowed values

3100

1 - v1 error format

3101

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3102

3103

Returns:

3104

An object of the form:

3105

3106

{ # Contains a list of instances.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3107

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3108

"items": [ # A list of Instance resources.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3109

{ # 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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3110

"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.

3111

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3112

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3113

"numaNodeCount": 42, # The number of vNUMA nodes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3114

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3115

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3116

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3117

"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]

3118

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3119

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

3120

},

3121

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

3122

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3123

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

3124

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3125

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

3126

{ # An instance-attached disk resource.

3127

"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).

3128

"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]

3129

"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.

3130

"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-10-05 00:20:14 -0700

[diff] [blame]

3131

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3132

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3133

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3134

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3135

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3136

},

3137

"diskSizeGb": "A String", # The size of the disk in GB.

3138

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3139

"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]

3140

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3141

"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]

3142

},

3143

],

3144

"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]

3145

"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]

3146

"description": "A String", # An optional description. Provide this property when creating the disk.

3147

"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.

3148

"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]

3149

"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]

3150

"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]

3151

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3152

"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]

3153

},

3154

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

3155

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3156

"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.

3157

"a_key": "A String",

3158

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

3159

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

3160

"A String",

3161

],

3162

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

3163

"A String",

3164

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3165

"multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to more than one instance.

3166

"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]

3167

"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]

3168

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

3169

"A String",

3170

],

3171

"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.

3172

"A String",

3173

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3174

"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.

3175

"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-10-05 00:20:14 -0700

[diff] [blame]

3176

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3177

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3178

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3179

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3180

"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]

3181

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3182

"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]

3183

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3184

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3185

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3186

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3187

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3188

"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]

3189

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3190

},

3191

"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.

3192

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

3193

"licenses": [ # [Output Only] Any valid publicly visible licenses.

3194

"A String",

3195

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

3196

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3197

"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.

3198

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

3199

"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

3200

"dbs": [ # The Key Database (db).

3201

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3202

"content": "A String", # The raw content in the secure keys file.

3203

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3204

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3205

],

3206

"dbxs": [ # The forbidden key database (dbx).

3207

{

3208

"content": "A String", # The raw content in the secure keys file.

3209

"fileType": "A String", # The file type of source file.

3210

},

3211

],

3212

"keks": [ # The Key Exchange Key (KEK).

3213

{

3214

"content": "A String", # The raw content in the secure keys file.

3215

"fileType": "A String", # The file type of source file.

3216

},

3217

],

3218

"pk": { # The Platform Key (PK).

3219

"content": "A String", # The raw content in the secure keys file.

3220

"fileType": "A String", # The file type of source file.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3221

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3222

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3223

"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]

3224

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

3225

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3226

"A String",

3227

],

3228

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3229

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3230

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

3231

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

3232

},

3233

"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]

3234

"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]

3235

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3236

{ # A specification of the type and number of accelerator cards attached to the instance.

3237

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3238

"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.

3239

},

3240

],

3241

"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.

3242

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3243

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3244

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3245

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3246

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3247

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3248

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3249

},

3250

"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]

3251

"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]

3252

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

3253

"a_key": "A String",

3254

},

3255

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

3256

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

3257

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3258

"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]

3259

"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]

3260

"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]

3261

"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]

3262

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3263

"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.

3264

"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).

3265

},

3266

],

3267

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

3268

},

3269

"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".

3270

"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.

3271

"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.

3272

{ # A network interface resource attached to an instance.

3273

"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.

3274

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3275

"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.

3276

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

3277

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3278

"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.

3279

"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]

3280

"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]

3281

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

3282

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3283

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

3284

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3285

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3286

},

3287

],

3288

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

3289

{ # An alias IP range attached to an instance's network interface.

3290

"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).

3291

"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.

3292

},

3293

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3294

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3295

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

3296

"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.

3297

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

3298

"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.

3299

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

3300

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

3301

"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.

3302

"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]

3303

"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]

3304

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

3305

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3306

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

3307

"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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3308

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

3309

},

3310

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3311

"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]

3312

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

3313

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

3314

"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]

3315

"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]

3316

"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.

3317

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

3318

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3319

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3320

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

3321

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3322

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

3323

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3324

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

3325

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

3326

},

3327

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3328

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3329

},

3330

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3331

"networkPerformanceConfig": {

3332

"externalIpEgressBandwidthTier": "A String",

3333

"totalEgressBandwidthTier": "A String",

3334

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3335

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

3336

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3337

"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]

3338

"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]

3339

"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]

3340

"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]

3341

"values": [ # Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or "projects/different-project/reservations/some-reservation-name" to target a shared reservation in the same zone but in a different project.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies applied to this instance.

3346

"A String",

3347

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3348

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

3349

"scheduling": {

3350

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

3351

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

3352

"upcomingMaintenance": {

3353

"canReschedule": True or False, # Indicates if the maintenance can be customer triggered. See go/sf-ctm-design for more details

3354

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3355

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3356

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3357

"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]

3358

"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-03-02 11:49:08 -0800

[diff] [blame]

3359

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

3360

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

3361

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

3362

"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-08-31 00:28:27 -0700

[diff] [blame]

3363

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3364

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

3365

"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]

3366

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

3367

"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]

3368

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

3369

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

3370

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

3371

"key": "A String", # Corresponds to the label key of Node resource.

3372

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3373

"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.

3379

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

3380

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3381

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3382

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3383

"A String",

3384

],

3385

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3386

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3387

"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]

3388

{ # A service account.

3389

"email": "A String", # Email address of the service account.

3390

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

3396

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

3397

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

3398

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

3399

},

3400

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

3401

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3402

},

3403

"shieldedVmConfig": { # A set of Shielded VM options. # Deprecating, please use shielded_instance_config.

3404

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

3405

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

3406

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

3407

},

3408

"shieldedVmIntegrityPolicy": { # The policy describes the baseline against which VM instance boot integrity is measured. # Deprecating, please use shielded_instance_integrity_policy.

3409

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

3410

},

3411

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3412

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3413

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3414

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3415

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3416

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3417

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3418

},

3419

"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]

3420

"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]

3421

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

3422

"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]

3423

"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]

3424

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

3425

"A String",

3426

],

3427

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3428

"upcomingMaintenance": { # Upcoming Maintenance notification information. TODO(b/196881882) Deprecate this proto once it's fully migrated to be under proto ResourceStatus.UpcomingMaintenance. # [Output Only] Specifies upcoming maintenance for the instance.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3429

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3430

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

3431

"earliest": "A String",

3432

"latest": "A String",

3433

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3434

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

3435

"type": "A String", # Defines the type of maintenance.

3436

},

3437

"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]

3438

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3439

],

3440

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

3441

"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.

3442

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3443

"warning": { # [Output Only] Informational warning message.

3444

"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]

3445

"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]

3446

{

3447

"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).

3448

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3449

},

3450

],

3451

"message": "A String", # [Output Only] A human-readable description of the warning code.

3452

},

3453

}</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]

3457

<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]

3458

<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]

3459

3460

Args:

3461

project: string, Project ID for this request. (required)

3462

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3463

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]

3464

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]

3465

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]

3466

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]

3467

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]

3468

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]

3469

x__xgafv: string, V1 error format.

3470

Allowed values

3471

1 - v1 error format

3472

2 - v2 error format

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3473

3474

Returns:

3475

An object of the form:

3476

3477

{ # Contains a list of instance referrers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3478

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3479

"items": [ # A list of Reference resources.

3480

{ # Represents a reference to a resource.

3481

"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]

3482

"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]

3483

"referrer": "A String", # URL of the resource which refers to the target.

3484

"target": "A String", # URL of the resource to which this reference points.

3485

},

3486

],

3487

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

3488

"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.

3489

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3490

"warning": { # [Output Only] Informational warning message.

3491

"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]

3492

"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]

3493

{

3494

"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).

3495

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3496

},

3497

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3498

"message": "A String", # [Output Only] A human-readable description of the warning code.

3499

},

3500

}</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>

3505

<pre>Retrieves the next page of results.

3506

3507

Args:

3508

previous_request: The request for the previous page. (required)

3509

previous_response: The response from the request for the previous page. (required)

3510

3511

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3512

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3513

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]

3518

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3519

<pre>Retrieves the next page of results.

3520

3521

Args:

3522

previous_request: The request for the previous page. (required)

3523

previous_response: The response from the request for the previous page. (required)

3524

3525

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3526

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3527

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]

3532

<code class="details" id="performMaintenance">performMaintenance(project, zone, instance, requestId=None, x__xgafv=None)</code>

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

3533

<pre>Perform a manual maintenance on the instance.

3534

3535

Args:

3536

project: string, Project ID for this request. (required)

3537

zone: string, The name of the zone for this request. (required)

3538

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3539

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).

3540

x__xgafv: string, V1 error format.

3541

Allowed values

3542

1 - v1 error format

3543

2 - v2 error format

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

3544

3545

Returns:

3546

An object of the form:

3547

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3548

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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-06-05 00:38:05 -0700

[diff] [blame]

3549

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3550

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3551

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3552

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3553

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3554

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

3555

{

3556

"code": "A String", # [Output Only] The error type identifier for this error.

3557

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3558

"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`.

3563

"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.

3564

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3565

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3566

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3567

"name": "A String", # [Output Only] Name of the operation.

3568

"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.

3569

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3570

"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.

3571

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3572

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3573

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3574

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3575

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3576

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3577

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3578

"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.

3579

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3580

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3581

{

3582

"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]

3583

"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-06-05 00:38:05 -0700

[diff] [blame]

3584

{

3585

"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).

3586

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3587

},

3588

],

3589

"message": "A String", # [Output Only] A human-readable description of the warning code.

3590

},

3591

],

3592

"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]

3597

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3598

<pre>Removes resource policies from an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3599

3600

Args:

3601

project: string, Project ID for this request. (required)

3602

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3603

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3604

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3605

The object takes the form of:

3606

3607

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3608

"resourcePolicies": [ # Resource policies to be removed from this instance.

3609

"A String",

3610

],

3611

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3612

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3613

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).

3614

x__xgafv: string, V1 error format.

3615

Allowed values

3616

1 - v1 error format

3617

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3618

3619

Returns:

3620

An object of the form:

3621

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3622

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

3623

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3624

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3625

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3626

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3627

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3628

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3629

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3630

"code": "A String", # [Output Only] The error type identifier for this error.

3631

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3632

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3633

},

3634

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3635

},

3636

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3637

"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.

3638

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3639

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3640

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3641

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3642

"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]

3643

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3644

"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.

3645

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3646

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3647

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3648

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3649

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3650

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3651

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3652

"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.

3653

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3654

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3655

{

3656

"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]

3657

"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]

3658

{

3659

"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).

3660

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3661

},

3662

],

3663

"message": "A String", # [Output Only] A human-readable description of the warning code.

3664

},

3665

],

3666

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3667

}</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]

3671

<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]

3672

<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.

3673

3674

Args:

3675

project: string, Project ID for this request. (required)

3676

zone: string, The name of the zone for this request. (required)

3677

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3678

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).

3679

x__xgafv: string, V1 error format.

3680

Allowed values

3681

1 - v1 error format

3682

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3683

3684

Returns:

3685

An object of the form:

3686

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3687

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

3688

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3689

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3690

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3691

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3692

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3693

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3694

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3695

"code": "A String", # [Output Only] The error type identifier for this error.

3696

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3697

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3698

},

3699

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3700

},

3701

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3702

"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.

3703

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3704

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3705

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3706

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3707

"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]

3708

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3709

"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.

3710

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3711

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3712

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3713

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3714

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3715

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3716

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3717

"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.

3718

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3719

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3720

{

3721

"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]

3722

"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]

3723

{

3724

"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).

3725

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3726

},

3727

],

3728

"message": "A String", # [Output Only] A human-readable description of the warning code.

3729

},

3730

],

3731

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3732

}</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]

3736

<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]

3737

<pre>Resumes an instance that was suspended using the instances().suspend method.

3738

3739

Args:

3740

project: string, Project ID for this request. (required)

3741

zone: string, The name of the zone for this request. (required)

3742

instance: string, Name of the instance resource to resume. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3743

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3744

The object takes the form of:

3745

3746

{

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3747

"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]

3748

{

3749

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3750

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3751

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3752

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3753

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3754

"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]

3755

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3756

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ disk_name

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3757

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3758

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3759

"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-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

3760

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

3761

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

3762

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

3763

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

3764

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

3765

},

3766

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3767

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3768

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).

3769

x__xgafv: string, V1 error format.

3770

Allowed values

3771

1 - v1 error format

3772

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3773

3774

Returns:

3775

An object of the form:

3776

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3777

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

3778

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3779

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3780

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3781

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3782

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3783

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3784

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3785

"code": "A String", # [Output Only] The error type identifier for this error.

3786

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3787

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3788

},

3789

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3790

},

3791

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3792

"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.

3793

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3794

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3795

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3796

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3797

"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]

3798

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3799

"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.

3800

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3801

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3802

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3803

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3804

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3805

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3806

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3807

"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.

3808

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3809

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3810

{

3811

"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]

3812

"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]

3813

{

3814

"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).

3815

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3816

},

3817

],

3818

"message": "A String", # [Output Only] A human-readable description of the warning code.

3819

},

3820

],

3821

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3822

}</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]

3826

<code class="details" id="sendDiagnosticInterrupt">sendDiagnosticInterrupt(project, zone, instance, x__xgafv=None)</code>

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

3827

<pre>Sends diagnostic interrupt to the instance.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3828

3829

Args:

3830

project: string, Project ID for this request. (required)

3831

zone: string, The name of the zone for this request. (required)

3832

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3833

x__xgafv: string, V1 error format.

3834

Allowed values

3835

1 - v1 error format

3836

2 - v2 error format

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3841

<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]

3842

<pre>Sets deletion protection on the instance.

3843

3844

Args:

3845

project: string, Project ID for this request. (required)

3846

zone: string, The name of the zone for this request. (required)

3847

resource: string, Name or id of the resource for this request. (required)

3848

deletionProtection: boolean, Whether the resource should be protected against deletion.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3849

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).

3850

x__xgafv: string, V1 error format.

3851

Allowed values

3852

1 - v1 error format

3853

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3854

3855

Returns:

3856

An object of the form:

3857

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3858

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

3859

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3860

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3861

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3862

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3863

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3864

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3865

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3866

"code": "A String", # [Output Only] The error type identifier for this error.

3867

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3868

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3869

},

3870

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3871

},

3872

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3873

"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.

3874

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3875

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3876

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3877

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3878

"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]

3879

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3880

"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.

3881

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3882

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3883

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3884

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3885

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3886

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3887

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3888

"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.

3889

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3890

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3891

{

3892

"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]

3893

"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]

3894

{

3895

"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).

3896

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3897

},

3898

],

3899

"message": "A String", # [Output Only] A human-readable description of the warning code.

3900

},

3901

],

3902

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3903

}</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]

3907

<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]

3908

<pre>Sets the auto-delete flag for a disk attached to an instance.

3909

3910

Args:

3911

project: string, Project ID for this request. (required)

3912

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3913

instance: string, The instance name for this request. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3914

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]

3915

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]

3916

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).

3917

x__xgafv: string, V1 error format.

3918

Allowed values

3919

1 - v1 error format

3920

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3921

3922

Returns:

3923

An object of the form:

3924

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3925

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

3926

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3927

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3928

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3929

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3930

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3931

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3932

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3933

"code": "A String", # [Output Only] The error type identifier for this error.

3934

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3935

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3936

},

3937

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3938

},

3939

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3940

"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.

3941

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3942

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3943

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3944

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3945

"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]

3946

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3947

"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.

3948

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3949

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3950

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3951

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3952

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3953

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3954

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3955

"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.

3956

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3957

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3958

{

3959

"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]

3960

"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]

3961

{

3962

"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).

3963

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3964

},

3965

],

3966

"message": "A String", # [Output Only] A human-readable description of the warning code.

3967

},

3968

],

3969

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3970

}</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]

3974

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3975

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

3976

3977

Args:

3978

project: string, Project ID for this request. (required)

3979

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3980

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3981

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3982

The object takes the form of:

3983

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3984

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3985

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

3986

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3987

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

3988

"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]

3989

"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.

3990

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3991

"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.

3992

"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.

3993

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

3994

"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]

3995

"A String",

3996

],

3997

"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]

3998

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3999

],

4000

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

4001

"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]

4002

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4003

{ # 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]

4004

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4005

{ # 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.

4006

"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]

4007

"A String",

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

4008

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4009

"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]

4010

"logType": "A String", # The log type that this config enables.

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

4011

},

4012

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4013

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4014

"A String",

4015

],

4016

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4017

},

4018

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4019

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4020

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4021

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

4022

"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]

4023

"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.

4024

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4025

"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.

4026

"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.

4027

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4028

"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]

4029

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4030

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4031

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4032

},

4033

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4034

"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.

4035

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

4036

"rules": [ # This is deprecated and has no effect. Do not use.

4037

{ # This is deprecated and has no effect. Do not use.

4038

"action": "A String", # This is deprecated and has no effect. Do not use.

4039

"conditions": [ # This is deprecated and has no effect. Do not use.

4040

{ # This is deprecated and has no effect. Do not use.

4041

"iam": "A String", # This is deprecated and has no effect. Do not use.

4042

"op": "A String", # This is deprecated and has no effect. Do not use.

4043

"svc": "A String", # This is deprecated and has no effect. Do not use.

4044

"sys": "A String", # This is deprecated and has no effect. Do not use.

4045

"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]

4050

"description": "A String", # This is deprecated and has no effect. Do not use.

4051

"ins": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4052

"A String",

4053

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4054

"logConfigs": [ # This is deprecated and has no effect. Do not use.

4055

{ # This is deprecated and has no effect. Do not use.

4056

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4057

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4058

"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]

4059

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4060

"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]

4061

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4062

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4063

"customFields": [ # This is deprecated and has no effect. Do not use.

4064

{ # This is deprecated and has no effect. Do not use.

4065

"name": "A String", # This is deprecated and has no effect. Do not use.

4066

"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]

4067

},

4068

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4069

"field": "A String", # This is deprecated and has no effect. Do not use.

4070

"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]

4071

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4072

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4073

"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]

4074

},

4075

},

4076

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4077

"notIns": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4078

"A String",

4079

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4080

"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]

4085

"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]

4089

x__xgafv: string, V1 error format.

4090

Allowed values

4091

1 - v1 error format

4092

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4093

4094

Returns:

4095

An object of the form:

4096

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

4097

{ # 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]

4098

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4099

{ # 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]

4100

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4101

{ # 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.

4102

"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]

4103

"A String",

4104

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4105

"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]

4106

"logType": "A String", # The log type that this config enables.

4107

},

4108

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4109

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4110

"A String",

4111

],

4112

"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.

4113

},

4114

],

4115

"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.

4116

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4117

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

4118

"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]

4119

"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.

4120

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

4121

"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.

4122

"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.

4123

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4124

"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]

4125

"A String",

4126

],

4127

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

4128

},

4129

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4130

"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.

4131

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

4132

"rules": [ # This is deprecated and has no effect. Do not use.

4133

{ # This is deprecated and has no effect. Do not use.

4134

"action": "A String", # This is deprecated and has no effect. Do not use.

4135

"conditions": [ # This is deprecated and has no effect. Do not use.

4136

{ # This is deprecated and has no effect. Do not use.

4137

"iam": "A String", # This is deprecated and has no effect. Do not use.

4138

"op": "A String", # This is deprecated and has no effect. Do not use.

4139

"svc": "A String", # This is deprecated and has no effect. Do not use.

4140

"sys": "A String", # This is deprecated and has no effect. Do not use.

4141

"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]

4146

"description": "A String", # This is deprecated and has no effect. Do not use.

4147

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4148

"A String",

4149

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4150

"logConfigs": [ # This is deprecated and has no effect. Do not use.

4151

{ # This is deprecated and has no effect. Do not use.

4152

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4153

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4154

"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]

4155

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4156

"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]

4157

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4158

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4159

"customFields": [ # This is deprecated and has no effect. Do not use.

4160

{ # This is deprecated and has no effect. Do not use.

4161

"name": "A String", # This is deprecated and has no effect. Do not use.

4162

"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]

4163

},

4164

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4165

"field": "A String", # This is deprecated and has no effect. Do not use.

4166

"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]

4167

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4168

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

4169

"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]

4170

},

4171

},

4172

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4173

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4174

"A String",

4175

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4176

"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]

4181

"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]

4182

}</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]

4186

<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]

4187

<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]

4188

4189

Args:

4190

project: string, Project ID for this request. (required)

4191

zone: string, The name of the zone for this request. (required)

4192

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4193

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4194

The object takes the form of:

4195

4196

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4197

"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]

4202

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4203

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).

4204

x__xgafv: string, V1 error format.

4205

Allowed values

4206

1 - v1 error format

4207

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4208

4209

Returns:

4210

An object of the form:

4211

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4212

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4213

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4214

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4215

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4216

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4217

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4218

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4219

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4220

"code": "A String", # [Output Only] The error type identifier for this error.

4221

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4222

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4223

},

4224

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4225

},

4226

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4227

"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.

4228

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4229

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4230

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4231

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4232

"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]

4233

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4234

"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.

4235

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4236

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4237

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4238

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4239

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4240

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4241

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4242

"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.

4243

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4244

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4245

{

4246

"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]

4247

"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]

4248

{

4249

"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).

4250

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4251

},

4252

],

4253

"message": "A String", # [Output Only] A human-readable description of the warning code.

4254

},

4255

],

4256

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4257

}</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]

4261

<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]

4262

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

4263

4264

Args:

4265

project: string, Project ID for this request. (required)

4266

zone: string, The name of the zone for this request. (required)

4267

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4268

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4269

The object takes the form of:

4270

4271

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4272

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

4273

{ # A specification of the type and number of accelerator cards attached to the instance.

4274

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4275

"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.

4276

},

4277

],

4278

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4279

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4280

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).

4281

x__xgafv: string, V1 error format.

4282

Allowed values

4283

1 - v1 error format

4284

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4285

4286

Returns:

4287

An object of the form:

4288

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4289

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4290

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4291

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4292

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4293

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4294

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4295

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4296

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4297

"code": "A String", # [Output Only] The error type identifier for this error.

4298

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4299

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4300

},

4301

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4302

},

4303

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4304

"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.

4305

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4306

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4307

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4308

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4309

"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]

4310

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4311

"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.

4312

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4313

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4314

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4315

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4316

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4317

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4318

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4319

"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.

4320

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4321

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4322

{

4323

"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]

4324

"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]

4325

{

4326

"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).

4327

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4328

},

4329

],

4330

"message": "A String", # [Output Only] A human-readable description of the warning code.

4331

},

4332

],

4333

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4334

}</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]

4338

<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]

4339

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

4340

4341

Args:

4342

project: string, Project ID for this request. (required)

4343

zone: string, The name of the zone for this request. (required)

4344

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4345

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4346

The object takes the form of:

4347

4348

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4349

"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

4350

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4351

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4352

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).

4353

x__xgafv: string, V1 error format.

4354

Allowed values

4355

1 - v1 error format

4356

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4357

4358

Returns:

4359

An object of the form:

4360

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4361

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4362

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4363

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4364

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4365

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4366

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4367

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4368

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4369

"code": "A String", # [Output Only] The error type identifier for this error.

4370

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4371

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4372

},

4373

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4374

},

4375

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4376

"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.

4377

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4378

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4379

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4380

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4381

"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]

4382

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4383

"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.

4384

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4385

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4386

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4387

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4388

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4389

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4390

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4391

"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.

4392

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4393

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4394

{

4395

"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]

4396

"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]

4397

{

4398

"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).

4399

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4400

},

4401

],

4402

"message": "A String", # [Output Only] A human-readable description of the warning code.

4403

},

4404

],

4405

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4406

}</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]

4410

<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]

4411

<pre>Sets metadata for the specified instance to the data included in the request.

4412

4413

Args:

4414

project: string, Project ID for this request. (required)

4415

zone: string, The name of the zone for this request. (required)

4416

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4417

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4418

The object takes the form of:

4419

4420

{ # A metadata key/value entry.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4421

"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]

4422

"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]

4423

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4424

"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.

4425

"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).

4426

},

4427

],

4428

"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]

4429

}

4430

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4431

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).

4432

x__xgafv: string, V1 error format.

4433

Allowed values

4434

1 - v1 error format

4435

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4436

4437

Returns:

4438

An object of the form:

4439

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4440

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4441

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4442

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4443

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4444

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4445

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4446

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4447

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4448

"code": "A String", # [Output Only] The error type identifier for this error.

4449

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4450

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4451

},

4452

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4453

},

4454

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4455

"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.

4456

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4457

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4458

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4459

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4460

"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]

4461

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4462

"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.

4463

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4464

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4465

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4466

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4467

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4468

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4469

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4470

"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.

4471

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4472

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4473

{

4474

"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]

4475

"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]

4476

{

4477

"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).

4478

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4479

},

4480

],

4481

"message": "A String", # [Output Only] A human-readable description of the warning code.

4482

},

4483

],

4484

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4485

}</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]

4489

<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]

4490

<pre>Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4491

4492

Args:

4493

project: string, Project ID for this request. (required)

4494

zone: string, The name of the zone for this request. (required)

4495

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4496

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4497

The object takes the form of:

4498

4499

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4500

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

4501

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4502

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4503

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).

4504

x__xgafv: string, V1 error format.

4505

Allowed values

4506

1 - v1 error format

4507

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

4508

4509

Returns:

4510

An object of the form:

4511

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4512

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4513

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4514

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4515

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4516

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4517

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4518

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4519

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4520

"code": "A String", # [Output Only] The error type identifier for this error.

4521

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4522

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4523

},

4524

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4525

},

4526

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4527

"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.

4528

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4529

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4530

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4531

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4532

"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]

4533

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4534

"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.

4535

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4536

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4537

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4538

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4539

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4540

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4541

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4542

"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.

4543

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4544

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4545

{

4546

"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]

4547

"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]

4548

{

4549

"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).

4550

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4551

},

4552

],

4553

"message": "A String", # [Output Only] A human-readable description of the warning code.

4554

},

4555

],

4556

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4557

}</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]

4561

<code class="details" id="setName">setName(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4562

<pre>Sets name of an instance.

4563

4564

Args:

4565

project: string, Project ID for this request. (required)

4566

zone: string, The name of the zone for this request. (required)

4567

instance: string, The instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4568

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4569

The object takes the form of:

4570

4571

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4572

"currentName": "A String", # The current name of this resource, used to prevent conflicts. Provide the latest name when making a request to change name.

4573

"name": "A String", # The name to be applied to the instance. Needs to be RFC 1035 compliant.

4574

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4575

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4576

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).

4577

x__xgafv: string, V1 error format.

4578

Allowed values

4579

1 - v1 error format

4580

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4581

4582

Returns:

4583

An object of the form:

4584

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4585

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4586

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4587

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4588

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4589

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4590

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4591

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4592

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4593

"code": "A String", # [Output Only] The error type identifier for this error.

4594

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4595

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4596

},

4597

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4598

},

4599

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4600

"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.

4601

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4602

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4603

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4604

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4605

"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]

4606

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4607

"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.

4608

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4609

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4610

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4611

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4612

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4613

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4614

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4615

"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.

4616

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4617

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4618

{

4619

"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]

4620

"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]

4621

{

4622

"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).

4623

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4624

},

4625

],

4626

"message": "A String", # [Output Only] A human-readable description of the warning code.

4627

},

4628

],

4629

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4630

}</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]

4634

<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]

4635

<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]

4636

4637

Args:

4638

project: string, Project ID for this request. (required)

4639

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4640

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4641

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4642

The object takes the form of:

4643

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4644

{ # Sets the scheduling options for an Instance. NextID: 21

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4645

"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-03-02 11:49:08 -0800

[diff] [blame]

4646

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

4647

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

4648

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

4649

"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-08-31 00:28:27 -0700

[diff] [blame]

4650

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4651

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

4652

"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]

4653

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

4654

"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]

4655

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

4656

"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]

4657

{ # 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]

4658

"key": "A String", # Corresponds to the label key of Node resource.

4659

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4660

"values": [ # Corresponds to the label values of Node resource.

4661

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4662

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4663

},

4664

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4665

"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]

4666

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

4667

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4668

}

4669

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4670

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).

4671

x__xgafv: string, V1 error format.

4672

Allowed values

4673

1 - v1 error format

4674

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4675

4676

Returns:

4677

An object of the form:

4678

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4679

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4680

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4681

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4682

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4683

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4684

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4685

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4686

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4687

"code": "A String", # [Output Only] The error type identifier for this error.

4688

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4689

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4690

},

4691

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4692

},

4693

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4694

"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.

4695

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4696

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4697

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4698

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4699

"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]

4700

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4701

"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.

4702

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4703

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4704

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4705

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4706

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4707

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4708

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4709

"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.

4710

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4711

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4712

{

4713

"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]

4714

"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]

4715

{

4716

"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).

4717

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4718

},

4719

],

4720

"message": "A String", # [Output Only] A human-readable description of the warning code.

4721

},

4722

],

4723

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4724

}</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]

4728

<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]

4729

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4730

4731

Args:

4732

project: string, Project ID for this request. (required)

4733

zone: string, The name of the zone for this request. (required)

4734

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4735

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4736

The object takes the form of:

4737

4738

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4739

"email": "A String", # Email address of the service account.

4740

"scopes": [ # The list of scopes to be made available for this service account.

4741

"A String",

4742

],

4743

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4744

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4745

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).

4746

x__xgafv: string, V1 error format.

4747

Allowed values

4748

1 - v1 error format

4749

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4750

4751

Returns:

4752

An object of the form:

4753

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4754

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4755

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4756

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4757

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4758

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4759

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4760

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4761

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4762

"code": "A String", # [Output Only] The error type identifier for this error.

4763

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4764

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4765

},

4766

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4767

},

4768

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4769

"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.

4770

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4771

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4772

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4773

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4774

"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]

4775

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4776

"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.

4777

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4778

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4779

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4780

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4781

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4782

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4783

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4784

"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.

4785

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4786

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4787

{

4788

"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]

4789

"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]

4790

{

4791

"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).

4792

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4793

},

4794

],

4795

"message": "A String", # [Output Only] A human-readable description of the warning code.

4796

},

4797

],

4798

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4799

}</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]

4803

<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]

4804

<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.

4805

4806

Args:

4807

project: string, Project ID for this request. (required)

4808

zone: string, The name of the zone for this request. (required)

4809

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4810

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4811

The object takes the form of:

4812

4813

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4814

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4815

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4816

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4817

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).

4818

x__xgafv: string, V1 error format.

4819

Allowed values

4820

1 - v1 error format

4821

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4822

4823

Returns:

4824

An object of the form:

4825

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4826

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4827

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4828

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4829

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4830

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4831

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4832

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4833

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4834

"code": "A String", # [Output Only] The error type identifier for this error.

4835

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4836

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4837

},

4838

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4839

},

4840

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4841

"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.

4842

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4843

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4844

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4845

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4846

"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]

4847

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4848

"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.

4849

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4850

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4851

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4852

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4853

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4854

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4855

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4856

"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.

4857

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4858

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4859

{

4860

"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]

4861

"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]

4862

{

4863

"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).

4864

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4865

},

4866

],

4867

"message": "A String", # [Output Only] A human-readable description of the warning code.

4868

},

4869

],

4870

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4871

}</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]

4875

<code class="details" id="setShieldedVmIntegrityPolicy">setShieldedVmIntegrityPolicy(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4876

<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.

4877

4878

Args:

4879

project: string, Project ID for this request. (required)

4880

zone: string, The name of the zone for this request. (required)

4881

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4882

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4883

The object takes the form of:

4884

4885

{ # The policy describes the baseline against which VM instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4886

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4887

}

4888

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4889

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).

4890

x__xgafv: string, V1 error format.

4891

Allowed values

4892

1 - v1 error format

4893

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4894

4895

Returns:

4896

An object of the form:

4897

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4898

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4899

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4900

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4901

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4902

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4903

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4904

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4905

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4906

"code": "A String", # [Output Only] The error type identifier for this error.

4907

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4908

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4909

},

4910

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4911

},

4912

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4913

"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.

4914

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4915

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4916

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4917

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4918

"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]

4919

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4920

"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.

4921

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4922

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4923

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4924

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4925

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4926

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4927

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4928

"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.

4929

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4930

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4931

{

4932

"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]

4933

"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]

4934

{

4935

"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).

4936

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4937

},

4938

],

4939

"message": "A String", # [Output Only] A human-readable description of the warning code.

4940

},

4941

],

4942

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4943

}</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]

4947

<code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4948

<pre>Sets network tags for the specified instance to the data included in the request.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4949

4950

Args:

4951

project: string, Project ID for this request. (required)

4952

zone: string, The name of the zone for this request. (required)

4953

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4954

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4955

The object takes the form of:

4956

4957

{ # A set of instance tags.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4958

"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]

4959

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

4960

"A String",

4961

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4962

}

4963

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4964

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).

4965

x__xgafv: string, V1 error format.

4966

Allowed values

4967

1 - v1 error format

4968

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4969

4970

Returns:

4971

An object of the form:

4972

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

4973

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

4974

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4975

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4976

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4977

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4978

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4979

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4980

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4981

"code": "A String", # [Output Only] The error type identifier for this error.

4982

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4983

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4984

},

4985

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4986

},

4987

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4988

"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.

4989

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4990

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4991

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4992

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4993

"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]

4994

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4995

"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.

4996

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4997

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4998

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4999

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5000

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5001

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5002

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5003

"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.

5004

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5005

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5006

{

5007

"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]

5008

"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]

5009

{

5010

"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).

5011

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5012

},

5013

],

5014

"message": "A String", # [Output Only] A human-readable description of the warning code.

5015

},

5016

],

5017

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5018

}</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]

5022

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</code>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5023

<pre>Simulates a maintenance event on the instance.

5024

5025

Args:

5026

project: string, Project ID for this request. (required)

5027

zone: string, The name of the zone for this request. (required)

5028

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5029

x__xgafv: string, V1 error format.

5030

Allowed values

5031

1 - v1 error format

5032

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5033

5034

Returns:

5035

An object of the form:

5036

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5037

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5038

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5039

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5040

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5041

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5042

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5043

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5044

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5045

"code": "A String", # [Output Only] The error type identifier for this error.

5046

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5047

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5048

},

5049

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5050

},

5051

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5052

"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.

5053

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5054

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5055

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5056

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5057

"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]

5058

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5059

"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.

5060

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5061

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5062

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5063

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5064

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5065

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5066

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5067

"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.

5068

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5069

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5070

{

5071

"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]

5072

"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]

5073

{

5074

"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).

5075

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5076

},

5077

],

5078

"message": "A String", # [Output Only] A human-readable description of the warning code.

5079

},

5080

],

5081

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5082

}</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]

5086

<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]

5087

<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]

5088

5089

Args:

5090

project: string, Project ID for this request. (required)

5091

zone: string, The name of the zone for this request. (required)

5092

instance: string, Name of the instance resource to start. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5093

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).

5094

x__xgafv: string, V1 error format.

5095

Allowed values

5096

1 - v1 error format

5097

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5098

5099

Returns:

5100

An object of the form:

5101

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5102

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5103

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5104

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5105

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5106

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5107

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5108

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5109

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5110

"code": "A String", # [Output Only] The error type identifier for this error.

5111

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5112

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5113

},

5114

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5115

},

5116

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5117

"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.

5118

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5119

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5120

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5121

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5122

"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]

5123

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5124

"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.

5125

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5126

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5127

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5128

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5129

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5130

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5131

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5132

"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.

5133

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5134

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5135

{

5136

"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]

5137

"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]

5138

{

5139

"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).

5140

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5141

},

5142

],

5143

"message": "A String", # [Output Only] A human-readable description of the warning code.

5144

},

5145

],

5146

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5147

}</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]

5151

<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]

5152

<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]

5153

5154

Args:

5155

project: string, Project ID for this request. (required)

5156

zone: string, The name of the zone for this request. (required)

5157

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5158

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5159

The object takes the form of:

5160

5161

{

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5162

"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]

5163

{

5164

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5165

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5166

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5167

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5168

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5169

"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]

5170

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5171

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. For example: "source": "/compute/v1/projects/project_id/zones/zone/disks/ disk_name

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5172

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5173

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5174

"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 start will not succeed.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5175

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5176

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5177

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5178

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5179

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5180

},

5181

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5182

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5183

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).

5184

x__xgafv: string, V1 error format.

5185

Allowed values

5186

1 - v1 error format

5187

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5188

5189

Returns:

5190

An object of the form:

5191

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5192

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5193

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5194

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5195

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5196

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5197

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5198

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5199

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5200

"code": "A String", # [Output Only] The error type identifier for this error.

5201

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5202

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5203

},

5204

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5205

},

5206

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5207

"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.

5208

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5209

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5210

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5211

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5212

"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]

5213

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5214

"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.

5215

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5216

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5217

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5218

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5219

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5220

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5221

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5222

"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.

5223

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5224

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5225

{

5226

"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]

5227

"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]

5228

{

5229

"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).

5230

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5231

},

5232

],

5233

"message": "A String", # [Output Only] A human-readable description of the warning code.

5234

},

5235

],

5236

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5237

}</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]

5241

<code class="details" id="stop">stop(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5242

<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]

5243

5244

Args:

5245

project: string, Project ID for this request. (required)

5246

zone: string, The name of the zone for this request. (required)

5247

instance: string, Name of the instance resource to stop. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5248

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]

5249

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).

5250

x__xgafv: string, V1 error format.

5251

Allowed values

5252

1 - v1 error format

5253

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5254

5255

Returns:

5256

An object of the form:

5257

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5258

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5259

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5260

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5261

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5262

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5263

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5264

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5265

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5266

"code": "A String", # [Output Only] The error type identifier for this error.

5267

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5268

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5269

},

5270

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5271

},

5272

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5273

"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.

5274

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5275

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5276

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5277

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5278

"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]

5279

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5280

"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.

5281

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5282

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5283

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5284

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5285

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5286

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5287

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5288

"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.

5289

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5290

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5291

{

5292

"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]

5293

"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]

5294

{

5295

"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).

5296

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5297

},

5298

],

5299

"message": "A String", # [Output Only] A human-readable description of the warning code.

5300

},

5301

],

5302

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5303

}</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]

5307

<code class="details" id="suspend">suspend(project, zone, instance, discardLocalSsd=None, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5308

<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.

5309

5310

Args:

5311

project: string, Project ID for this request. (required)

5312

zone: string, The name of the zone for this request. (required)

5313

instance: string, Name of the instance resource to suspend. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

5314

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]

5315

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).

5316

x__xgafv: string, V1 error format.

5317

Allowed values

5318

1 - v1 error format

5319

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5320

5321

Returns:

5322

An object of the form:

5323

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5324

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5325

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5326

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5327

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5328

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5329

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5330

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5331

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5332

"code": "A String", # [Output Only] The error type identifier for this error.

5333

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5334

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5335

},

5336

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5337

},

5338

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5339

"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.

5340

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5341

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5342

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5343

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5344

"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]

5345

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5346

"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.

5347

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5348

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5349

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5350

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5351

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5352

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5353

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5354

"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.

5355

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5356

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5357

{

5358

"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]

5359

"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]

5360

{

5361

"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).

5362

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5363

},

5364

],

5365

"message": "A String", # [Output Only] A human-readable description of the warning code.

5366

},

5367

],

5368

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5369

}</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]

5373

<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]

5374

<pre>Returns permissions that a caller has on the specified resource.

5375

5376

Args:

5377

project: string, Project ID for this request. (required)

5378

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5379

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5380

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5381

The object takes the form of:

5382

5383

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5384

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

5385

"A String",

5386

],

5387

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5388

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5389

x__xgafv: string, V1 error format.

5390

Allowed values

5391

1 - v1 error format

5392

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5393

5394

Returns:

5395

An object of the form:

5396

5397

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5398

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

5399

"A String",

5400

],

5401

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

5405

<code class="details" id="update">update(project, zone, instance, body=None, clearSecureTag=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5406

<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]

5407

5408

Args:

5409

project: string, Project ID for this request. (required)

5410

zone: string, The name of the zone for this request. (required)

5411

instance: string, Name of the instance resource to update. (required)

5412

body: object, The request body.

5413

The object takes the form of:

5414

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5415

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5416

"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.

5417

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5418

"enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

5419

"numaNodeCount": 42, # The number of vNUMA nodes.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5420

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

5421

"visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5422

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5423

"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-05-20 12:08:20 -0700

[diff] [blame]

5424

"confidentialInstanceConfig": { # A set of Confidential Instance options.

5425

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5426

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5427

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

5428

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5429

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

5430

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5431

"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]

5432

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5433

"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).

5434

"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]

5435

"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.

5436

"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-10-05 00:20:14 -0700

[diff] [blame]

5437

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5438

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5439

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5440

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5441

"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]

5442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5443

"diskSizeGb": "A String", # The size of the disk in GB.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5444

"forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5445

"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]

5446

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5447

"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]

5448

},

5449

],

5450

"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]

5451

"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]

5452

"description": "A String", # An optional description. Provide this property when creating the disk.

5453

"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.

5454

"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]

5455

"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]

5456

"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]

5457

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5458

"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]

5459

},

5460

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

5461

"interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5462

"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.

5463

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5464

},

yoshi-code-bot

2021-08-24 00:22:31 -0700

[diff] [blame]

5465

"licenseCodes": [ # Integer license codes indicating which licenses are attached to this disk.

5466

"A String",

5467

],

5468

"licenses": [ # A list of publicly visible licenses. Reserved for Google's use.

5469

"A String",

5470

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5471

"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]

5472

"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]

5473

"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]

5474

"replicaZones": [ # URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

5475

"A String",

5476

],

5477

"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.

5478

"A String",

5479

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5480

"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.

5481

"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-10-05 00:20:14 -0700

[diff] [blame]

5482

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5483

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5484

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5485

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5486

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5487

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5488

"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]

5489

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5490

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5491

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5492

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5493

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5494

"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]

5495

},

5496

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5497

"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.

5498

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

5499

"licenses": [ # [Output Only] Any valid publicly visible licenses.

5500

"A String",

5501

],

yoshi-code-bot

2021-08-31 00:28:27 -0700

[diff] [blame]

5502

"locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep-disk parameter set to true for locked disks.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5503

"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.

5504

"savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

5505

"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

5506

"dbs": [ # The Key Database (db).

5507

{

5508

"content": "A String", # The raw content in the secure keys file.

5509

"fileType": "A String", # The file type of source file.

5510

},

5511

],

5512

"dbxs": [ # The forbidden key database (dbx).

5513

{

5514

"content": "A String", # The raw content in the secure keys file.

5515

"fileType": "A String", # The file type of source file.

5516

},

5517

],

5518

"keks": [ # The Key Exchange Key (KEK).

5519

{

5520

"content": "A String", # The raw content in the secure keys file.

5521

"fileType": "A String", # The file type of source file.

5522

},

5523

],

5524

"pk": { # The Platform Key (PK).

5525

"content": "A String", # The raw content in the secure keys file.

5526

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5527

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5528

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5529

"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]

5530

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5531

"userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created.

5532

"A String",

5533

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5534

},

5535

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5536

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

5537

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5538

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5539

"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]

5540

"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]

5541

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

5542

{ # A specification of the type and number of accelerator cards attached to the instance.

5543

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

5544

"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.

5545

},

5546

],

5547

"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.

5548

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5549

"instanceEncryptionKey": { # Encrypts or decrypts data for an instance with a customer-supplied encryption key. If you are creating a new instance, this field encrypts the local SSD and in-memory contents of the instance using a key that you provide. If you are restarting an instance protected with a customer-supplied encryption key, you must provide the correct key in order to successfully restart the instance. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key and you do not need to provide a key to start the instance later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt local SSDs and in-memory content in a managed instance group.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5550

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5551

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5552

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5553

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5554

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5555

},

5556

"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]

5557

"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]

5558

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

5559

"a_key": "A String",

5560

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5561

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

5562

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

5563

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5564

"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]

5565

"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]

5566

"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]

5567

"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]

5568

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5569

"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.

5570

"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).

5571

},

5572

],

5573

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

5574

},

5575

"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".

5576

"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.

5577

"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.

5578

{ # A network interface resource attached to an instance.

5579

"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.

5580

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5581

"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.

5582

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5583

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5584

"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.

5585

"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]

5586

"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]

5587

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5588

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5589

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5590

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5591

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

5592

},

5593

],

5594

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

5595

{ # An alias IP range attached to an instance's network interface.

5596

"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).

5597

"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.

5598

},

5599

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

5600

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5601

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

5602

"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.

5603

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

5604

"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.

5605

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

5606

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5607

"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.

5608

"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]

5609

"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-11-16 11:05:03 -0700

[diff] [blame]

5610

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5611

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5612

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5613

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5614

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

5615

},

5616

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5617

"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]

5618

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

5619

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

5620

"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]

5621

"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]

5622

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5623

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

5624

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5625

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5626

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

5627

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

5628

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

5629

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5630

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

5631

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

5632

},

5633

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5634

"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]

5635

},

5636

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5637

"networkPerformanceConfig": {

5638

"externalIpEgressBandwidthTier": "A String",

5639

"totalEgressBandwidthTier": "A String",

5640

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5641

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5642

"preservedStateSizeGb": "A String", # Total amount of preserved state for SUSPENDED instances. Read-only in the api.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5643

"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]

5644

"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]

5645

"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]

5646

"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]

5647

"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.

5652

"A String",

5653

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5654

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

5655

"scheduling": {

5656

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

5657

},

yoshi-code-bot

2021-06-05 00:38:05 -0700

[diff] [blame]

5658

"upcomingMaintenance": {

5659

"canReschedule": True or False, # Indicates if the maintenance can be customer triggered. See go/sf-ctm-design for more details

5660

},

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5661

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5662

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

5663

"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]

5664

"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-03-02 11:49:08 -0800

[diff] [blame]

5665

"availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.

yoshi-code-bot

2021-07-20 00:20:24 -0700

[diff] [blame]

5666

"currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type.

5667

"currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type.

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

5668

"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-08-31 00:28:27 -0700

[diff] [blame]

5669

"instanceTerminationAction": "A String", # Specifies the termination action for the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5670

"latencyTolerant": True or False, # Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set.

5671

"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]

5672

"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.

5673

"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]

5674

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

5675

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

5676

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

5677

"key": "A String", # Corresponds to the label key of Node resource.

5678

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

5679

"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]

5685

"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.

yoshi-code-bot

2021-06-29 00:20:25 -0700

[diff] [blame]

5686

"provisioningModel": "A String", # Specifies the provisioning model of the instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5687

},

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

5688

"secureTags": [ # [Input Only] Secure tags to apply to this instance. These can be later modified by the update method. Maximum number of secure tags allowed is 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

5689

"A String",

5690

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5691

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

5692

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5693

"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]

5694

{ # A service account.

5695

"email": "A String", # Email address of the service account.

5696

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

5702

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

5703

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

5704

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

5705

},

5706

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

5707

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5708

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5709

"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]

5710

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

5711

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

5712

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

5713

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5714

"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]

5715

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

5716

},

5717

"sourceMachineImage": "A String", # Source machine image

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

5718

"sourceMachineImageEncryptionKey": { # Source machine image encryption key when creating an instance from a machine image.

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5719

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key

5720

"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. For example: "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/

5721

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rawKey": "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="

5722

"rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: "rsaEncryptedKey": "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==" 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]

5723

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

5724

},

5725

"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]

5726

"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]

5727

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

5728

"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]

5729

"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]

5730

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

5731

"A String",

5732

],

5733

},

yoshi-code-bot

2021-10-05 00:20:14 -0700

[diff] [blame]

5734

"upcomingMaintenance": { # Upcoming Maintenance notification information. TODO(b/196881882) Deprecate this proto once it's fully migrated to be under proto ResourceStatus.UpcomingMaintenance. # [Output Only] Specifies upcoming maintenance for the instance.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5735

"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5736

"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. # [Output Only] The start time window of the maintenance disruption.

5737

"earliest": "A String",

5738

"latest": "A String",

5739

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5740

"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use start_time_window instead.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5741

"type": "A String", # Defines the type of maintenance.

5742

},

5743

"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]

5744

}

5745

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5746

clearSecureTag: boolean, Whether to clear secure tags from the instance. This property if set to true will clear secure tags regardless of the resource.secure_tags.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5747

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.

5748

Allowed values

5749

INVALID -

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5750

NO_EFFECT - No changes can be made to the instance.

5751

REFRESH - The instance will not restart.

5752

RESTART - The instance will restart.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5753

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.

5754

Allowed values

5755

INVALID -

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5756

NO_EFFECT - No changes can be made to the instance.

5757

REFRESH - The instance will not restart.

5758

RESTART - The instance will restart.

5759

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).

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5760

x__xgafv: string, V1 error format.

5761

Allowed values

5762

1 - v1 error format

5763

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5764

5765

Returns:

5766

An object of the form:

5767

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5768

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5769

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5770

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5771

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5772

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5773

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5774

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5775

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5776

"code": "A String", # [Output Only] The error type identifier for this error.

5777

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5778

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5779

},

5780

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5781

},

5782

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5783

"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.

5784

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5785

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5786

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5787

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5788

"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]

5789

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5790

"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.

5791

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5792

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5793

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5794

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5795

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5796

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5797

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5798

"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.

5799

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5800

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5801

{

5802

"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]

5803

"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]

5804

{

5805

"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).

5806

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5807

},

5808

],

5809

"message": "A String", # [Output Only] A human-readable description of the warning code.

5810

},

5811

],

5812

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5813

}</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]

5817

<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]

5818

<pre>Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5819

5820

Args:

5821

project: string, Project ID for this request. (required)

5822

zone: string, The name of the zone for this request. (required)

5823

instance: string, The instance name for this request. (required)

5824

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]

5825

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5826

The object takes the form of:

5827

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5828

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5829

"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.

5830

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5831

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5832

"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.

5833

"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]

5834

"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]

5835

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5836

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5837

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5838

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5839

"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]

5840

}

5841

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5842

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).

5843

x__xgafv: string, V1 error format.

5844

Allowed values

5845

1 - v1 error format

5846

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5847

5848

Returns:

5849

An object of the form:

5850

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5851

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5852

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5853

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5854

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5855

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5856

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5857

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5858

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5859

"code": "A String", # [Output Only] The error type identifier for this error.

5860

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5861

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5862

},

5863

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5864

},

5865

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5866

"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.

5867

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5868

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5869

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5870

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5871

"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]

5872

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5873

"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.

5874

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5875

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5876

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5877

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5878

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5879

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5880

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5881

"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.

5882

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5883

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5884

{

5885

"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]

5886

"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]

5887

{

5888

"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).

5889

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5890

},

5891

],

5892

"message": "A String", # [Output Only] A human-readable description of the warning code.

5893

},

5894

],

5895

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5896

}</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]

5900

<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]

5901

<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.

5902

5903

Args:

5904

project: string, Project ID for this request. (required)

5905

zone: string, The name of the zone for this request. (required)

5906

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5907

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5908

The object takes the form of:

5909

5910

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5911

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5912

}

5913

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5914

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).

5915

x__xgafv: string, V1 error format.

5916

Allowed values

5917

1 - v1 error format

5918

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5919

5920

Returns:

5921

An object of the form:

5922

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5923

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

5924

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5925

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5926

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5927

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5928

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5929

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5930

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5931

"code": "A String", # [Output Only] The error type identifier for this error.

5932

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5933

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5934

},

5935

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

5936

},

5937

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5938

"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.

5939

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5940

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5941

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5942

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

5943

"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]

5944

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5945

"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.

5946

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5947

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5948

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5949

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5950

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5951

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5952

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5953

"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.

5954

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5955

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5956

{

5957

"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]

5958

"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]

5959

{

5960

"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).

5961

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5962

},

5963

],

5964

"message": "A String", # [Output Only] A human-readable description of the warning code.

5965

},

5966

],

5967

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

5968

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5969

</div>

5970

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5971

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

5972

<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]

5973

<pre>Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5974

5975

Args:

5976

project: string, Project ID for this request. (required)

5977

zone: string, The name of the zone for this request. (required)

5978

instance: string, The instance name for this request. (required)

5979

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5980

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

5981

The object takes the form of:

5982

5983

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5984

"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.

5985

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

5986

"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.

5987

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5988

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

5989

"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.

5990

"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]

5991

"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]

5992

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5993

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5994

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

5995

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5996

"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]

5997

},

5998

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5999

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

6000

{ # An alias IP range attached to an instance's network interface.

6001

"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).

6002

"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.

6003

},

6004

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

6005

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6006

"internalIpv6PrefixLength": 42, # [Output Only] The prefix length of the primary internal IPv6 range.

6007

"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.

6008

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

6009

"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.

6010

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

6011

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

6012

"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.

6013

"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]

6014

"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-11-16 11:05:03 -0700

[diff] [blame]

6015

"publicDnsName": "A String", # [Output Only] The public DNS domain name for the instance.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

6016

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6017

"setPublicDns": True or False, # Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration.

yoshi-code-bot

2021-11-15 23:24:17 -0800

[diff] [blame]

6018

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6019

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

6020

},

6021

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6022

"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]

6023

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

6024

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

6025

"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]

6026

"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]

6027

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

6028

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

6029

"queueCount": 42, # The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6030

"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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6031

"subinterfaces": [ # SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface.

6032

{

yoshi-code-bot

2021-05-25 00:30:03 -0700

[diff] [blame]

6033

"ipAddress": "A String", # An IPv4 internal IP address to assign to the instance for this subinterface. If specified, ip_allocation_mode should be set to ALLOCATE_IP.

6034

"ipAllocationMode": "A String",

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6035

"subnetwork": "A String", # If specified, this subnetwork must belong to the same network as that of the network interface. If not specified the subnet of network interface will be used. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - 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]

6036

"vlan": 42, # VLAN tag. Should match the VLAN(s) supported by the subnetwork to which this subinterface is connecting.

6037

},

6038

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6039

"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

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6040

}

6041

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6042

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).

6043

x__xgafv: string, V1 error format.

6044

Allowed values

6045

1 - v1 error format

6046

2 - v2 error format

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

6047

6048

Returns:

6049

An object of the form:

6050

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6051

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

6052

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6053

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6054

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6055

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6056

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6057

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6058

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6059

"code": "A String", # [Output Only] The error type identifier for this error.

6060

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6061

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6062

},

6063

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6064

},

6065

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6066

"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.

6067

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6068

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6069

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6070

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6071

"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]

6072

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6073

"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.

6074

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6075

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6076

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6077

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6078

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6079

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6080

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6081

"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.

6082

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6083

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6084

{

6085

"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]

6086

"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]

6087

{

6088

"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).

6089

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6090

},

6091

],

6092

"message": "A String", # [Output Only] A human-readable description of the warning code.

6093

},

6094

],

6095

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6096

}</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]

6100

<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]

6101

<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.

6102

6103

Args:

6104

project: string, Project ID for this request. (required)

6105

zone: string, The name of the zone for this request. (required)

6106

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6107

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6108

The object takes the form of:

6109

6110

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6111

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

6112

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

6113

"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]

6114

}

6115

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6116

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).

6117

x__xgafv: string, V1 error format.

6118

Allowed values

6119

1 - v1 error format

6120

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6121

6122

Returns:

6123

An object of the form:

6124

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6125

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

6126

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6127

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6128

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6129

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6130

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6131

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6132

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6133

"code": "A String", # [Output Only] The error type identifier for this error.

6134

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6135

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6136

},

6137

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6138

},

6139

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6140

"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.

6141

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6142

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6143

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6144

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6145

"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]

6146

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6147

"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.

6148

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6149

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6150

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6151

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6152

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6153

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6154

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6155

"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.

6156

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6157

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6158

{

6159

"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]

6160

"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]

6161

{

6162

"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).

6163

"value": "A String", # [Output Only] A warning data value corresponding to the key.

6164

},

6165

],

6166

"message": "A String", # [Output Only] A human-readable description of the warning code.

6167

},

6168

],

6169

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

6170

}</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]

6174

<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]

6175

<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.

6176

6177

Args:

6178

project: string, Project ID for this request. (required)

6179

zone: string, The name of the zone for this request. (required)

6180

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

6181

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6182

The object takes the form of:

6183

6184

{ # A set of Shielded VM options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6185

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.

6186

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.

6187

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6188

}

6189

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6190

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).

6191

x__xgafv: string, V1 error format.

6192

Allowed values

6193

1 - v1 error format

6194

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

6195

6196

Returns:

6197

An object of the form:

6198

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame]

6199

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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]

6200

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

6201

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

6202

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

6203

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

6204

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

6205

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6206

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6207

"code": "A String", # [Output Only] The error type identifier for this error.

6208

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

6209

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6210

},

6211

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

6212

},

6213

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

6214

"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.

6215

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

6216

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

6217

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

6218

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

6219

"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]

6220

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

6221

"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.

6222

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

6223

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6224

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

6225

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

6226

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

6227

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

6228

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

6229

"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.

6230

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

6231

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

6232

{

6233

"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]

6234

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot