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

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

[diff] [blame^]

84

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

Bu Sun Kim

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

[diff] [blame]

85

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

John Asmuth

2014-04-24 15:46:26 -0400

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

yoshi-code-bot

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

[diff] [blame^]

93

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

yoshi-code-bot

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

[diff] [blame]

94

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

95

Dmitry Frenkel

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

[diff] [blame]

96

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

97

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

98

yoshi-code-bot

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

[diff] [blame^]

99

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

Anthonios Partheniou

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

[diff] [blame]

100

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

John Asmuth

2014-04-24 15:46:26 -0400

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

John Asmuth

2014-04-24 15:46:26 -0400

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

John Asmuth

2014-04-24 15:46:26 -0400

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

yoshi-code-bot

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

[diff] [blame]

112

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

113

yoshi-code-bot

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

[diff] [blame^]

114

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

Bu Sun Kim

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

[diff] [blame]

115

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

116

yoshi-code-bot

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

[diff] [blame^]

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

119

yoshi-code-bot

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

[diff] [blame^]

120

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

Dmitry Frenkel

2020-10-06 16:46:05 -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>

John Asmuth

2014-04-24 15:46:26 -0400

[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="#insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

130

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

131

yoshi-code-bot

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

[diff] [blame^]

132

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

133

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

134

yoshi-code-bot

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

[diff] [blame^]

135

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

136

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

Bu Sun Kim

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

[diff] [blame]

137

138

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

139

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

140

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

141

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

142

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

143

yoshi-code-bot

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

[diff] [blame^]

144

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

Dan O'Meara

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

[diff] [blame]

145

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

146

yoshi-code-bot

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

[diff] [blame^]

147

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

148

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

149

yoshi-code-bot

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

[diff] [blame^]

150

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

151

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

152

yoshi-code-bot

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

[diff] [blame^]

153

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

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

154

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

155

yoshi-code-bot

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

[diff] [blame^]

156

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

Bu Sun Kim

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

[diff] [blame]

157

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

Sai Cheemalapati

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

[diff] [blame]

158

yoshi-code-bot

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

[diff] [blame^]

159

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

160

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

161

yoshi-code-bot

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

[diff] [blame^]

162

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

163

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

164

yoshi-code-bot

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

[diff] [blame^]

165

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

166

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

167

yoshi-code-bot

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

[diff] [blame^]

168

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

169

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

170

yoshi-code-bot

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

[diff] [blame^]

171

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

172

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

173

yoshi-code-bot

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

[diff] [blame^]

174

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

175

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

176

yoshi-code-bot

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

[diff] [blame^]

177

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

178

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

179

yoshi-code-bot

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

[diff] [blame^]

180

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

181

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

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

182

yoshi-code-bot

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

[diff] [blame^]

183

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

184

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

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

185

yoshi-code-bot

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

[diff] [blame^]

186

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

Bu Sun Kim

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

[diff] [blame]

187

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

188

yoshi-code-bot

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

[diff] [blame^]

189

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

190

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

191

yoshi-code-bot

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

[diff] [blame^]

192

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

193

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

194

yoshi-code-bot

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

[diff] [blame^]

195

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

Bu Sun Kim

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

[diff] [blame]

196

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

197

yoshi-code-bot

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

[diff] [blame^]

198

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

Bu Sun Kim

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

[diff] [blame]

199

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

200

yoshi-code-bot

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

[diff] [blame^]

201

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

202

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

203

yoshi-code-bot

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

[diff] [blame^]

204

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

205

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

206

yoshi-code-bot

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

[diff] [blame^]

207

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

Dan O'Meara

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

[diff] [blame]

208

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

209

yoshi-code-bot

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

[diff] [blame^]

210

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

211

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

212

yoshi-code-bot

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

[diff] [blame^]

213

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

214

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

215

<h3>Method Details</h3>

216

yoshi-code-bot

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

[diff] [blame^]

217

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

218

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

219

220

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

221

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

222

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

223

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

224

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]

225

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

226

The object takes the form of:

227

Bu Sun Kim

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

[diff] [blame]

228

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

yoshi-code-bot

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

[diff] [blame]

229

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

230

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

Bu Sun Kim

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

[diff] [blame]

231

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

232

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

233

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

234

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

235

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

236

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

237

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

238

}

239

yoshi-code-bot

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

[diff] [blame^]

240

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

241

x__xgafv: string, V1 error format.

242

Allowed values

243

1 - v1 error format

244

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

245

246

Returns:

247

An object of the form:

248

yoshi-code-bot

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

[diff] [blame^]

249

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

250

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

251

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

252

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

253

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

254

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

255

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

Bu Sun Kim

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

[diff] [blame]

256

{

Yoshi Automation Bot

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

[diff] [blame]

257

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

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

},

261

],

Yoshi Automation Bot

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

[diff] [blame]

262

},

263

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

264

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

265

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

266

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

267

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

268

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

yoshi-code-bot

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

[diff] [blame]

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

{

282

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

283

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

284

{

285

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

286

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

287

},

288

],

289

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

290

},

291

],

292

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

293

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

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

[diff] [blame^]

297

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

Dan O'Meara

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

[diff] [blame]

298

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

299

300

Args:

301

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

302

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

303

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

304

body: object, The request body.

305

The object takes the form of:

306

307

{

Yoshi Automation Bot

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

[diff] [blame]

308

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

309

"A String",

310

],

311

}

Dan O'Meara

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

[diff] [blame]

312

yoshi-code-bot

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

[diff] [blame^]

313

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

314

x__xgafv: string, V1 error format.

315

Allowed values

316

1 - v1 error format

317

2 - v2 error format

Dan O'Meara

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

[diff] [blame]

318

319

Returns:

320

An object of the form:

321

yoshi-code-bot

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

[diff] [blame^]

322

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

323

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

324

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

325

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

326

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

327

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

328

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

Bu Sun Kim

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

[diff] [blame]

329

{

Yoshi Automation Bot

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

[diff] [blame]

330

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

331

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

332

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

Bu Sun Kim

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

[diff] [blame]

333

},

334

],

Yoshi Automation Bot

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

[diff] [blame]

335

},

336

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

337

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

338

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

339

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

340

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

341

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

yoshi-code-bot

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

[diff] [blame]

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

{

355

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

356

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

357

{

358

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

359

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

360

},

361

],

362

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

363

},

364

],

365

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

366

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

370

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

Bu Sun Kim

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

[diff] [blame]

371

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

372

373

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

374

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

yoshi-code-bot

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

[diff] [blame^]

375

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]

376

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]

377

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

378

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]

379

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]

380

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

381

x__xgafv: string, V1 error format.

382

Allowed values

383

1 - v1 error format

384

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

385

386

Returns:

387

An object of the form:

388

389

{

Yoshi Automation Bot

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

[diff] [blame]

390

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

391

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

392

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

393

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

yoshi-code-bot

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

[diff] [blame^]

394

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

yoshi-code-bot

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

[diff] [blame]

395

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

396

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

Anthonios Partheniou

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

[diff] [blame]

397

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

yoshi-code-bot

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

[diff] [blame]

398

},

yoshi-code-bot

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

[diff] [blame^]

399

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

400

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

401

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

402

},

403

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

404

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

405

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

406

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

407

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

408

{ # An instance-attached disk resource.

409

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

410

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

411

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

412

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Yoshi Automation Bot

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

[diff] [blame]

413

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

414

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

415

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

416

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

417

},

418

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

yoshi-code-bot

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

[diff] [blame^]

419

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

420

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame^]

421

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

422

},

423

],

424

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

425

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

426

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

427

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

428

"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-16 00:22:06 -0700

[diff] [blame^]

429

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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 Automation Bot

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

[diff] [blame]

430

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

431

"a_key": "A String",

432

},

433

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

yoshi-code-bot

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

[diff] [blame]

434

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

Yoshi Automation Bot

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

[diff] [blame]

435

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

436

"A String",

437

],

yoshi-code-bot

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

[diff] [blame^]

438

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

439

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

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

[diff] [blame]

440

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

441

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

442

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

443

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

444

},

yoshi-code-bot

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

[diff] [blame^]

445

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

446

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

447

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

448

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

449

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

450

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

451

},

Yoshi Automation Bot

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

[diff] [blame]

452

},

453

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

454

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

455

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

456

"A String",

457

],

458

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

459

"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

460

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

461

{

Bu Sun Kim

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

[diff] [blame]

462

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

463

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

Dan O'Meara

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

[diff] [blame]

464

},

Yoshi Automation Bot

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

[diff] [blame]

465

],

466

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

467

{

468

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

469

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

470

},

471

],

472

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

473

{

474

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

475

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

476

},

477

],

478

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

479

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

480

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

Dan O'Meara

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

[diff] [blame]

481

},

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

482

},

yoshi-code-bot

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

[diff] [blame^]

483

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

484

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

Bu Sun Kim

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

[diff] [blame]

485

},

Yoshi Automation Bot

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

[diff] [blame]

486

],

487

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

488

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

489

},

yoshi-code-bot

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

[diff] [blame^]

490

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

491

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

492

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

493

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

494

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

495

},

496

],

497

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

498

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

499

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

500

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

501

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

502

"a_key": "A String",

503

},

504

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

505

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

506

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

yoshi-code-bot

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

[diff] [blame^]

507

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

508

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

509

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. 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]

510

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

511

{ # Metadata

Yoshi Automation Bot

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

[diff] [blame]

512

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

513

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

Bu Sun Kim

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

[diff] [blame]

514

},

515

],

Yoshi Automation Bot

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

[diff] [blame]

516

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

517

},

518

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

519

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

520

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

521

{ # A network interface resource attached to an instance.

522

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

523

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

yoshi-code-bot

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

[diff] [blame]

524

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

525

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

Yoshi Automation Bot

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

[diff] [blame]

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

},

Bu Sun Kim

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

[diff] [blame]

534

],

Yoshi Automation Bot

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

[diff] [blame]

535

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

536

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

537

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

538

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

539

},

540

],

yoshi-code-bot

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

[diff] [blame]

541

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

yoshi-code-bot

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

[diff] [blame]

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

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

[diff] [blame]

550

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

551

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

552

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

553

},

554

],

yoshi-code-bot

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

[diff] [blame^]

555

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

556

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

557

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

558

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

559

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

560

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

yoshi-code-bot

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

[diff] [blame]

561

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

yoshi-code-bot

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

[diff] [blame^]

562

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

563

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

564

},

Yoshi Automation Bot

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

[diff] [blame]

565

],

yoshi-code-bot

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

[diff] [blame^]

566

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

567

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

568

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

569

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

570

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

571

"A String",

572

],

Yoshi Automation Bot

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

[diff] [blame]

573

},

574

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

575

"A String",

576

],

yoshi-code-bot

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

[diff] [blame]

577

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

yoshi-code-bot

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

[diff] [blame]

578

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

579

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

580

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

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

[diff] [blame]

581

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

582

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

583

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

584

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

585

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

586

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

Bu Sun Kim

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

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

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

[diff] [blame]

591

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

592

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

593

},

594

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

yoshi-code-bot

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

[diff] [blame^]

595

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

596

{ # A service account.

597

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

598

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

Bu Sun Kim

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

[diff] [blame]

599

"A String",

600

],

601

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

602

],

Yoshi Automation Bot

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

[diff] [blame]

603

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

604

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

605

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

606

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

607

},

608

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

609

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

610

},

611

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

612

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

613

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

614

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

615

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

616

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

"A String",

],

},

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

Bu Sun Kim

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

[diff] [blame]

621

},

622

],

Yoshi Automation Bot

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

[diff] [blame]

623

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

624

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

625

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

626

{

627

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

628

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

629

},

630

],

631

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

632

},

Bu Sun Kim

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

[diff] [blame]

633

},

Yoshi Automation Bot

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

[diff] [blame]

634

},

635

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

636

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

637

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

638

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

639

"A String",

640

],

641

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

642

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

643

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

644

{

645

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

646

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

647

},

648

],

649

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

650

},

651

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

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

656

<pre>Retrieves the next page of results.

657

658

Args:

659

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

660

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

661

662

Returns:

Bu Sun Kim

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

[diff] [blame]

663

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

664

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

669

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

670

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

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

671

672

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

673

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

674

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

675

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

Dan O'Meara

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

[diff] [blame]

676

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

677

The object takes the form of:

678

679

{ # An instance-attached disk resource.

Bu Sun Kim

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

[diff] [blame]

680

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

681

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

682

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

683

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

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

[diff] [blame]

684

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

685

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

686

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

687

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

688

},

Bu Sun Kim

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

[diff] [blame]

689

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

yoshi-code-bot

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

[diff] [blame^]

690

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

691

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame^]

692

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

693

},

694

],

695

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

696

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

697

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

698

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

699

"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-16 00:22:06 -0700

[diff] [blame^]

700

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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.

Bu Sun Kim

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

[diff] [blame]

701

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

702

"a_key": "A String",

703

},

704

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

yoshi-code-bot

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

[diff] [blame]

705

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

Bu Sun Kim

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

[diff] [blame]

706

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

707

"A String",

Bu Sun Kim

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

[diff] [blame]

708

],

yoshi-code-bot

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

[diff] [blame^]

709

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

710

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

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

[diff] [blame]

711

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

712

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

713

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

714

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

715

},

yoshi-code-bot

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

[diff] [blame^]

716

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

717

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

Bu Sun Kim

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

[diff] [blame]

718

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

719

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

720

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

721

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

722

},

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

723

},

Bu Sun Kim

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

[diff] [blame]

724

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

725

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

726

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

727

"A String",

728

],

729

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

730

"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

731

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

Dan O'Meara

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

[diff] [blame]

732

{

Bu Sun Kim

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

[diff] [blame]

733

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

734

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

Dan O'Meara

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

[diff] [blame]

735

},

736

],

Bu Sun Kim

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

[diff] [blame]

737

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

Dan O'Meara

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

[diff] [blame]

738

{

Bu Sun Kim

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

[diff] [blame]

739

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

740

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

Dan O'Meara

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

[diff] [blame]

741

},

742

],

Bu Sun Kim

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

[diff] [blame]

743

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

Dan O'Meara

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

[diff] [blame]

744

{

Bu Sun Kim

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

[diff] [blame]

745

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

746

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

Dan O'Meara

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

[diff] [blame]

747

},

748

],

Bu Sun Kim

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

[diff] [blame]

749

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

750

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

751

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

Dan O'Meara

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

[diff] [blame]

752

},

753

},

yoshi-code-bot

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

[diff] [blame^]

754

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

755

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

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

756

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

757

Dmitry Frenkel

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

[diff] [blame]

758

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

759

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

760

x__xgafv: string, V1 error format.

761

Allowed values

762

1 - v1 error format

763

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

764

765

Returns:

766

An object of the form:

767

yoshi-code-bot

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

[diff] [blame^]

768

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

769

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

770

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

771

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

772

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

773

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

774

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

Bu Sun Kim

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

[diff] [blame]

775

{

Yoshi Automation Bot

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

[diff] [blame]

776

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

777

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

778

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

Bu Sun Kim

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

[diff] [blame]

779

},

780

],

Yoshi Automation Bot

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

[diff] [blame]

781

},

782

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

783

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

784

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

785

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

786

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

787

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

yoshi-code-bot

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

[diff] [blame]

788

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

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

{

801

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

yoshi-code-bot

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

[diff] [blame^]

802

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

yoshi-code-bot

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

[diff] [blame]

803

{

804

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

805

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

806

},

807

],

808

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

809

},

810

],

811

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

816

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

yoshi-code-bot

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

[diff] [blame]

817

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

818

819

Args:

820

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

821

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

822

body: object, The request body.

823

The object takes the form of:

824

yoshi-code-bot

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

[diff] [blame]

825

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

yoshi-code-bot

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

[diff] [blame]

826

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

827

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

828

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

829

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

Anthonios Partheniou

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

[diff] [blame]

830

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

yoshi-code-bot

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

[diff] [blame]

831

},

832

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

833

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

834

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

835

},

836

"description": "A String", # An optional text description for the instances that are created from these properties.

837

"disks": [ # An array of disks that are associated with the instances that are created from these properties.

838

{ # An instance-attached disk resource.

839

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

840

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

841

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

842

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

yoshi-code-bot

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

[diff] [blame]

843

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

844

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

845

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

846

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

847

},

848

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

yoshi-code-bot

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

[diff] [blame^]

849

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

yoshi-code-bot

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

[diff] [blame]

850

{ # Guest OS features.

yoshi-code-bot

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

[diff] [blame^]

851

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

yoshi-code-bot

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

[diff] [blame]

852

},

853

],

854

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

855

"initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both. # [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

yoshi-code-bot

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

[diff] [blame]

856

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

857

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

858

"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-16 00:22:06 -0700

[diff] [blame^]

859

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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-03-02 11:49:08 -0800

[diff] [blame]

860

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

861

"a_key": "A String",

862

},

863

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

864

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

865

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

866

"A String",

867

],

yoshi-code-bot

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

[diff] [blame^]

868

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

869

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

yoshi-code-bot

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

[diff] [blame]

870

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

871

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

872

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

873

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

874

},

yoshi-code-bot

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

[diff] [blame^]

875

"sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

yoshi-code-bot

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

[diff] [blame]

876

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

877

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

878

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

879

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

880

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

881

},

882

},

883

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

884

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

885

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

886

"A String",

887

],

888

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

889

"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

890

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

891

{

892

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

893

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

894

},

895

],

896

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

897

{

898

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

899

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

900

},

901

],

902

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

903

{

904

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

905

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

906

},

907

],

908

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

909

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

910

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

911

},

912

},

yoshi-code-bot

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

[diff] [blame^]

913

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk.

yoshi-code-bot

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

[diff] [blame]

914

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

915

},

916

],

917

"guestAccelerators": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.

918

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

919

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

920

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

921

},

922

],

923

"labels": { # Labels to apply to instances that are created from these properties.

924

"a_key": "A String",

925

},

926

"machineType": "A String", # The machine type to use for instances that are created from these properties.

927

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

928

"fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource.

yoshi-code-bot

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

[diff] [blame]

929

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

930

{ # Metadata

yoshi-code-bot

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

[diff] [blame]

931

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

932

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

933

},

934

],

935

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

936

},

937

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

938

"networkInterfaces": [ # An array of network access configurations for this interface.

939

{ # A network interface resource attached to an instance.

940

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

941

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

yoshi-code-bot

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

[diff] [blame]

942

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

943

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

yoshi-code-bot

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

[diff] [blame]

944

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

945

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

946

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

947

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

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

[diff] [blame]

948

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

949

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

950

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

951

},

952

],

953

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

954

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

955

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

956

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

957

},

958

],

yoshi-code-bot

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

[diff] [blame]

959

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

yoshi-code-bot

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

[diff] [blame]

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

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

[diff] [blame]

968

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

969

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

970

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

971

},

972

],

yoshi-code-bot

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

[diff] [blame^]

973

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

yoshi-code-bot

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

[diff] [blame]

974

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

975

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

976

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

977

"network": "A String", # URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

yoshi-code-bot

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

[diff] [blame]

978

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

979

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

yoshi-code-bot

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

[diff] [blame^]

980

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

981

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

yoshi-code-bot

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

[diff] [blame]

982

},

983

],

yoshi-code-bot

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

[diff] [blame^]

984

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

yoshi-code-bot

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

[diff] [blame]

985

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

986

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

yoshi-code-bot

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

[diff] [blame]

987

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

988

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

yoshi-code-bot

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

[diff] [blame]

"A String",

],

},

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

993

"A String",

994

],

yoshi-code-bot

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

[diff] [blame]

995

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

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

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

1009

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

1010

},

1011

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

1012

{ # A service account.

1013

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

1014

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

"A String",

],

},

],

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

1020

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

1021

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

1022

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

1023

},

1024

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

1025

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

yoshi-code-bot

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

[diff] [blame]

1026

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

1031

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

1032

"locations": { # Location configurations mapped by location name. Currently only zone names are supported and must be represented as valid internal URLs, such as zones/us-central1-a.

yoshi-code-bot

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

[diff] [blame]

1033

"a_key": {

yoshi-code-bot

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

[diff] [blame]

1034

"preference": "A String", # Preference for a given location: ALLOW or DENY.

yoshi-code-bot

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

[diff] [blame]

1035

},

1036

},

1037

},

Anthonios Partheniou

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

[diff] [blame]

1038

"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-16 00:22:06 -0700

[diff] [blame^]

1039

"namePattern": "A String", # The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern should contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: name_pattern of inst-#### will generate instance names such as inst-0001, inst-0002, ... . If there already exist instance(s) whose names match the name pattern in the same project and zone, then the generated instance numbers will start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### will be inst-0051, inst-0052, etc. The name pattern placeholder # ...# can contain up to 18 characters.

yoshi-code-bot

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

[diff] [blame]

1040

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

1041

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

1042

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

1043

},

1044

},

yoshi-code-bot

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

[diff] [blame^]

1045

"sourceInstanceTemplate": "A String", # Specifies the instance template from which to create instances. You may combine sourceInstanceTemplate with instanceProperties to override specific values from an existing instance template. Bulk API follows the semantics of JSON Merge Patch described by RFC 7396. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional.

yoshi-code-bot

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

[diff] [blame]

1046

}

1047

yoshi-code-bot

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

[diff] [blame^]

1048

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

1049

x__xgafv: string, V1 error format.

1050

Allowed values

1051

1 - v1 error format

1052

2 - v2 error format

yoshi-code-bot

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

[diff] [blame]

1053

1054

Returns:

1055

An object of the form:

1056

yoshi-code-bot

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

[diff] [blame^]

1057

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

yoshi-code-bot

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

[diff] [blame]

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

{

1065

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

1066

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

1067

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

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

1085

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

1086

"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.

1087

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1088

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1089

{

1090

"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^]

1091

"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]

1092

{

1093

"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).

1094

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1095

},

1096

],

1097

"message": "A String", # [Output Only] A human-readable description of the warning code.

1098

},

1099

],

1100

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1101

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1105

<code class="details" id="close">close()</code>

1106

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1110

<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]

1111

<pre>Deletes the specified Instance resource. For more information, see Deleting an instance.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1112

1113

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1114

project: string, Project ID for this request. (required)

1115

zone: string, The name of the zone for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1116

instance: string, Name of the instance resource to delete. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1117

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).

1118

x__xgafv: string, V1 error format.

1119

Allowed values

1120

1 - v1 error format

1121

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1122

1123

Returns:

1124

An object of the form:

1125

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1126

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

1127

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1128

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1129

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1130

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1131

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1132

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1133

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1134

"code": "A String", # [Output Only] The error type identifier for this error.

1135

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1136

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1137

},

1138

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1139

},

1140

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1141

"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.

1142

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1143

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1144

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1145

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1146

"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]

1147

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1148

"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.

1149

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1150

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1151

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1152

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1153

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1154

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1155

"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.

1156

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1157

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1158

{

1159

"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^]

1160

"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]

1161

{

1162

"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).

1163

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1164

},

1165

],

1166

"message": "A String", # [Output Only] A human-readable description of the warning code.

1167

},

1168

],

1169

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1170

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1174

<code class="details" id="deleteAccessConfig">deleteAccessConfig(project, zone, instance, accessConfig, networkInterface, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1175

<pre>Deletes an access config from an instance's network interface.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1176

1177

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1178

project: string, Project ID for this request. (required)

1179

zone: string, The name of the zone for this request. (required)

1180

instance: string, The instance name for this request. (required)

1181

accessConfig: string, The name of the access config to delete. (required)

1182

networkInterface: string, The name of the network interface. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1183

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).

1184

x__xgafv: string, V1 error format.

1185

Allowed values

1186

1 - v1 error format

1187

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1188

1189

Returns:

1190

An object of the form:

1191

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1192

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

1193

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1194

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1195

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1196

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1197

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1198

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1199

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1200

"code": "A String", # [Output Only] The error type identifier for this error.

1201

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1202

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1203

},

1204

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1205

},

1206

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1207

"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.

1208

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1209

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1210

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1211

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1212

"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]

1213

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1214

"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.

1215

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1216

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1217

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1218

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1219

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1220

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1221

"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.

1222

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1223

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1224

{

1225

"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^]

1226

"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]

1227

{

1228

"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).

1229

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1230

},

1231

],

1232

"message": "A String", # [Output Only] A human-readable description of the warning code.

1233

},

1234

],

1235

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1236

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1240

<code class="details" id="detachDisk">detachDisk(project, zone, instance, deviceName, requestId=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1241

<pre>Detaches a disk from an instance.

1242

1243

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1244

project: string, Project ID for this request. (required)

1245

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1246

instance: string, Instance name for this request. (required)

1247

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^]

1248

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).

1249

x__xgafv: string, V1 error format.

1250

Allowed values

1251

1 - v1 error format

1252

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1253

1254

Returns:

1255

An object of the form:

1256

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1257

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

1258

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1259

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1260

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1261

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1262

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1263

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1264

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1265

"code": "A String", # [Output Only] The error type identifier for this error.

1266

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1267

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1268

},

1269

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1270

},

1271

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1272

"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.

1273

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1274

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1275

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1276

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1277

"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]

1278

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1279

"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.

1280

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1281

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1282

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1283

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1284

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1285

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1286

"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.

1287

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1288

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1289

{

1290

"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^]

1291

"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]

1292

{

1293

"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).

1294

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1295

},

1296

],

1297

"message": "A String", # [Output Only] A human-readable description of the warning code.

1298

},

1299

],

1300

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1301

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1305

<code class="details" id="get">get(project, zone, instance, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1306

<pre>Returns the specified Instance resource. Gets a list of available instances by making a list() request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1307

1308

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1309

project: string, Project ID for this request. (required)

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

1310

zone: string, The name of the zone for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1311

instance: string, Name of the instance resource to return. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1312

x__xgafv: string, V1 error format.

1313

Allowed values

1314

1 - v1 error format

1315

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1316

1317

Returns:

1318

An object of the form:

1319

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1320

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1321

"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.

1322

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1323

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1324

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1325

"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]

1326

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1327

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1328

},

1329

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1330

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1331

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1332

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1333

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

1334

{ # An instance-attached disk resource.

1335

"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).

1336

"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^]

1337

"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.

1338

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1339

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1340

"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.

1341

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1342

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1343

},

1344

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1345

"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]

1346

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1347

"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]

1348

},

1349

],

1350

"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^]

1351

"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]

1352

"description": "A String", # An optional description. Provide this property when creating the disk.

1353

"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.

1354

"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-16 00:22:06 -0700

[diff] [blame^]

1355

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1356

"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.

1357

"a_key": "A String",

1358

},

1359

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1360

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1361

"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.

1362

"A String",

1363

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1364

"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.

1365

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1366

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1367

"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.

1368

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1369

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1370

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1371

"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]

1372

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

1373

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1374

"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.

1375

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1376

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1377

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1378

},

1379

"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.

1380

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1381

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1382

"A String",

1383

],

1384

"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.

1385

"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

1386

"dbs": [ # The Key Database (db).

1387

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1388

"content": "A String", # The raw content in the secure keys file.

1389

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1390

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1391

],

1392

"dbxs": [ # The forbidden key database (dbx).

1393

{

1394

"content": "A String", # The raw content in the secure keys file.

1395

"fileType": "A String", # The file type of source file.

1396

},

1397

],

1398

"keks": [ # The Key Exchange Key (KEK).

1399

{

1400

"content": "A String", # The raw content in the secure keys file.

1401

"fileType": "A String", # The file type of source file.

1402

},

1403

],

1404

"pk": { # The Platform Key (PK).

1405

"content": "A String", # The raw content in the secure keys file.

1406

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1407

},

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

1408

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1409

"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]

1410

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1411

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1412

],

1413

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1414

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1415

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1416

"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]

1417

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1418

{ # A specification of the type and number of accelerator cards attached to the instance.

1419

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1420

"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.

1421

},

1422

],

1423

"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.

1424

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1425

"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^]

1426

"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]

1427

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

1428

"a_key": "A String",

1429

},

1430

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

1431

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

1432

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1433

"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]

1434

"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^]

1435

"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]

1436

"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^]

1437

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1438

"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.

1439

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1440

},

1441

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1442

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

1443

},

1444

"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".

1445

"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.

1446

"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.

1447

{ # A network interface resource attached to an instance.

1448

"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.

1449

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1450

"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.

1451

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1452

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1453

"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.

1454

"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^]

1455

"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]

1456

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1457

"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.

1458

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1459

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1460

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1461

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

1462

{ # An alias IP range attached to an instance's network interface.

1463

"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).

1464

"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.

1465

},

1466

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1467

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1468

"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.

1469

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

1470

"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.

1471

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

1472

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

1473

"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.

1474

"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^]

1475

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1476

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

1477

"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.

1478

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

1479

},

1480

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1481

"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]

1482

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

1483

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

1484

"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^]

1485

"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]

1486

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1487

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1488

"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.

1489

"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]

1490

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1491

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1492

"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]

1493

"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^]

1494

"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]

1495

"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]

1496

"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]

1497

"A String",

1498

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1499

},

1500

"resourcePolicies": [ # Resource policies applied to this instance.

1501

"A String",

1502

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1503

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

1504

"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^]

1505

"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]

1506

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1507

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

1508

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

1509

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

1510

"key": "A String", # Corresponds to the label key of Node resource.

1511

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

1512

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1517

"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.

1518

"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.

1519

},

1520

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1521

"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]

1522

{ # A service account.

1523

"email": "A String", # Email address of the service account.

1524

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1525

"A String",

1526

],

1527

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1528

],

1529

"shieldedInstanceConfig": { # A set of Shielded Instance options.

1530

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

1531

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

1532

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

1533

},

1534

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

1535

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

1536

},

1537

"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^]

1538

"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]

1539

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

1540

"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^]

1541

"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]

1542

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1547

}</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^]

1551

<code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, zone, instance, networkInterface, x__xgafv=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1552

<pre>Returns effective firewalls applied to an interface of the instance.

1553

1554

Args:

1555

project: string, Project ID for this request. (required)

1556

zone: string, The name of the zone for this request. (required)

1557

instance: string, Name of the instance scoping this request. (required)

1558

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^]

1559

x__xgafv: string, V1 error format.

1560

Allowed values

1561

1 - v1 error format

1562

2 - v2 error format

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1563

1564

Returns:

1565

An object of the form:

1566

1567

{

1568

"firewallPolicys": [ # Effective firewalls from firewall policies.

1569

{

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1570

"displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1571

"name": "A String", # [Output Only] The name of the firewall policy.

1572

"rules": [ # The rules that apply to the network.

1573

{ # 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).

1574

"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.

1575

"description": "A String", # An optional description for this resource.

1576

"direction": "A String", # The direction in which this rule applies.

1577

"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.

1578

"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.

1579

"kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules

1580

"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.

1581

"destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 256.

1582

"A String",

1583

],

1584

"layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.

1585

{

1586

"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^]

1587

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"A String",

],

},

],

"srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 256.

1593

"A String",

1594

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1595

},

1596

"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.

1597

"ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.

1598

"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.

1599

"A String",

1600

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1601

"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]

1606

"shortName": "A String", # [Output Only] The short name of the firewall policy.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1607

"type": "A String", # [Output Only] The type of the firewall policy.

1608

},

1609

],

1610

"firewalls": [ # Effective firewalls on the instance.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1611

{ # 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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1612

"allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.

1613

{

1614

"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^]

1615

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"A String",

],

},

],

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1621

"denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.

1622

{

1623

"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^]

1624

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

"A String",

],

},

],

"description": "A String", # An optional description of this resource. Provide this field when you create the resource.

1630

"destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.

1631

"A String",

1632

],

1633

"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.

1634

"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.

1635

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1636

"kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules.

1637

"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.

1638

"enable": True or False, # This field denotes whether to enable logging for a particular firewall rule.

1639

"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.

1640

},

1641

"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^]

1642

"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-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1643

"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`.

1644

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1645

"sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.

1646

"A String",

1647

],

1648

"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.

1649

"A String",

1650

],

1651

"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.

1652

"A String",

1653

],

1654

"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.

1655

"A String",

1656

],

1657

"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",

],

},

],

}</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1666

<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]

1667

<pre>Returns the specified guest attributes entry.

1668

1669

Args:

1670

project: string, Project ID for this request. (required)

1671

zone: string, The name of the zone for this request. (required)

1672

instance: string, Name of the instance scoping this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1673

queryPath: string, Specifies the guest attributes path to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1674

variableKey: string, Specifies the key for the guest attributes entry.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1675

x__xgafv: string, V1 error format.

1676

Allowed values

1677

1 - v1 error format

1678

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1679

1680

Returns:

1681

An object of the form:

1682

1683

{ # A guest attributes entry.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1684

"kind": "compute#guestAttributes", # [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.

1685

"queryPath": "A String", # The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\/') or a specified key ('/\/\')

1686

"queryValue": { # Array of guest attribute namespace/key/value tuples. # [Output Only] The value of the requested queried path.

1687

"items": [

1688

{ # A guest attributes namespace/key/value entry.

1689

"key": "A String", # Key for the guest attribute entry.

1690

"namespace": "A String", # Namespace for the guest attribute entry.

1691

"value": "A String", # Value for the guest attribute entry.

},

],

},

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1696

"variableKey": "A String", # The key to search for.

1697

"variableValue": "A String", # [Output Only] The value found for the requested key.

1698

}</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^]

1702

<code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1703

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

1704

1705

Args:

1706

project: string, Project ID for this request. (required)

1707

zone: string, The name of the zone for this request. (required)

1708

resource: string, Name or id of the resource for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1709

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1710

x__xgafv: string, V1 error format.

1711

Allowed values

1712

1 - v1 error format

1713

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1714

1715

Returns:

1716

An object of the form:

1717

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1718

{ # 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]

1719

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1720

{ # 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]

1721

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1722

{ # 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.

1723

"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]

1724

"A String",

1725

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1726

"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]

1727

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1728

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1729

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1730

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1731

"A String",

1732

],

1733

"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.

1734

},

1735

],

1736

"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.

1737

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1738

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

1739

"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]

1740

"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.

1741

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1742

"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.

1743

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1744

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1745

"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]

1746

"A String",

1747

],

1748

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

1749

},

1750

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1751

"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.

1752

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

1753

"rules": [ # This is deprecated and has no effect. Do not use.

1754

{ # This is deprecated and has no effect. Do not use.

1755

"action": "A String", # This is deprecated and has no effect. Do not use.

1756

"conditions": [ # This is deprecated and has no effect. Do not use.

1757

{ # This is deprecated and has no effect. Do not use.

1758

"iam": "A String", # This is deprecated and has no effect. Do not use.

1759

"op": "A String", # This is deprecated and has no effect. Do not use.

1760

"svc": "A String", # This is deprecated and has no effect. Do not use.

1761

"sys": "A String", # This is deprecated and has no effect. Do not use.

1762

"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^]

1767

"description": "A String", # This is deprecated and has no effect. Do not use.

1768

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1769

"A String",

1770

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1771

"logConfigs": [ # This is deprecated and has no effect. Do not use.

1772

{ # This is deprecated and has no effect. Do not use.

1773

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1774

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1775

"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]

1776

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1777

"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]

1778

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1779

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1780

"customFields": [ # This is deprecated and has no effect. Do not use.

1781

{ # This is deprecated and has no effect. Do not use.

1782

"name": "A String", # This is deprecated and has no effect. Do not use.

1783

"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]

1784

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1785

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1786

"field": "A String", # This is deprecated and has no effect. Do not use.

1787

"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]

1788

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1789

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

1790

"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]

1791

},

1792

},

1793

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1794

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1795

"A String",

1796

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1797

"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^]

1802

"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]

1803

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1807

<code class="details" id="getScreenshot">getScreenshot(project, zone, instance, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1808

<pre>Returns the screenshot from the specified instance.

1809

1810

Args:

1811

project: string, Project ID for this request. (required)

1812

zone: string, The name of the zone for this request. (required)

1813

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1814

x__xgafv: string, V1 error format.

1815

Allowed values

1816

1 - v1 error format

1817

2 - v2 error format

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1818

1819

Returns:

1820

An object of the form:

1821

1822

{ # An instance's screenshot.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1823

"contents": "A String", # [Output Only] The Base64-encoded screenshot data.

1824

"kind": "compute#screenshot", # [Output Only] Type of the resource. Always compute#screenshot for the screenshots.

1825

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1829

<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]

1830

<pre>Returns the last 1 MB of serial port output from the specified instance.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1831

1832

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1833

project: string, Project ID for this request. (required)

1834

zone: string, The name of the zone for this request. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1835

instance: string, Name of the instance for this request. (required)

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

1836

port: integer, Specifies which COM or serial port to retrieve data from.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1837

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.

1838

x__xgafv: string, V1 error format.

1839

Allowed values

1840

1 - v1 error format

1841

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1842

1843

Returns:

1844

An object of the form:

1845

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1846

{ # An instance serial console output.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1847

"contents": "A String", # [Output Only] The contents of the console output.

1848

"kind": "compute#serialPortOutput", # [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.

1849

"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.

1850

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

1851

"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.

1852

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1856

<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]

1857

<pre>Returns the Shielded Instance Identity of an instance

1858

1859

Args:

1860

project: string, Project ID for this request. (required)

1861

zone: string, The name of the zone for this request. (required)

1862

instance: string, Name or id of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1863

x__xgafv: string, V1 error format.

1864

Allowed values

1865

1 - v1 error format

1866

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1867

1868

Returns:

1869

An object of the form:

1870

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1871

{ # A Shielded Instance Identity.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1872

"encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

1873

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

1874

"ekPub": "A String", # A PEM-encoded public key.

1875

},

1876

"kind": "compute#shieldedInstanceIdentity", # [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.

1877

"signingKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM.

1878

"ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.

1879

"ekPub": "A String", # A PEM-encoded public key.

1880

},

1881

}</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^]

1885

<code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceInstanceTemplate=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1886

<pre>Creates an instance resource in the specified project using the data included in the request.

1887

1888

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

1889

project: string, Project ID for this request. (required)

1890

zone: string, The name of the zone for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1891

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1892

The object takes the form of:

1893

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1894

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1895

"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.

1896

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

1897

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1898

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1899

"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 .

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1900

"confidentialInstanceConfig": { # A set of Confidential Instance options.

1901

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

1902

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1903

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

1904

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1905

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

1906

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1907

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1908

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

"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).

1910

"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^]

1911

"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.

1912

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1913

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1914

"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.

1915

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1916

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1917

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1918

"diskSizeGb": "A String", # The size of the disk in GB.

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1922

},

1923

],

1924

"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^]

1925

"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]

1926

"description": "A String", # An optional description. Provide this property when creating the disk.

1927

"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.

1928

"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-16 00:22:06 -0700

[diff] [blame^]

1929

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1930

"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.

1931

"a_key": "A String",

1932

},

1933

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1934

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1935

"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.

1936

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1937

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1938

"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.

1939

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1940

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1941

"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.

1942

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1943

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

1944

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1945

"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]

1946

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1947

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

1948

"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.

1949

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

1950

"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]

1951

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1952

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1953

"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.

1954

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

1955

"licenses": [ # [Output Only] Any valid publicly visible licenses.

1956

"A String",

1957

],

1958

"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.

1959

"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

1960

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1961

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1962

"content": "A String", # The raw content in the secure keys file.

1963

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1964

},

1965

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1966

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1967

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1968

"content": "A String", # The raw content in the secure keys file.

1969

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1970

},

1971

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1972

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1973

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1974

"content": "A String", # The raw content in the secure keys file.

1975

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1976

},

1977

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1978

"pk": { # The Platform Key (PK).

1979

"content": "A String", # The raw content in the secure keys file.

1980

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1981

},

1982

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1983

"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]

1984

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

1985

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1986

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1987

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

1988

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

1989

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1990

"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]

1991

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

1992

{ # A specification of the type and number of accelerator cards attached to the instance.

1993

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

1994

"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.

1995

},

1996

],

1997

"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.

1998

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1999

"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^]

2000

"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]

2001

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2002

"a_key": "A String",

2003

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2004

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2005

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2006

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2007

"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]

2008

"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^]

2009

"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]

2010

"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^]

2011

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2012

"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.

2013

"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).

2014

},

2015

],

2016

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2017

},

2018

"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".

2019

"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.

2020

"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.

2021

{ # A network interface resource attached to an instance.

2022

"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.

2023

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2024

"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.

2025

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2026

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2027

"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.

2028

"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^]

2029

"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]

2030

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2031

"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.

2032

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2033

},

2034

],

2035

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2036

{ # An alias IP range attached to an instance's network interface.

2037

"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).

2038

"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.

2039

},

2040

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2041

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2042

"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.

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-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2050

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2051

"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.

2052

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2053

},

2054

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2055

"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-07-22 17:02:09 -0700

[diff] [blame]

2056

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2057

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2058

"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^]

2059

"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]

2060

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2061

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2062

"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.

2063

"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]

2064

},

2065

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2066

"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]

2067

"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^]

2068

"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]

2069

"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]

2070

"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.

2075

"A String",

2076

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2077

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2078

"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^]

2079

"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]

2080

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2081

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2082

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2083

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2084

"key": "A String", # Corresponds to the label key of Node resource.

2085

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2086

"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]

2092

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2093

},

2094

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2095

"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]

2096

{ # A service account.

2097

"email": "A String", # Email address of the service account.

2098

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2104

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2105

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2106

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2107

},

2108

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2109

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2110

},

2111

"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^]

2112

"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]

2113

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2114

"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^]

2115

"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]

2116

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2121

}

2122

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2123

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).

2124

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

2125

x__xgafv: string, V1 error format.

2126

Allowed values

2127

1 - v1 error format

2128

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2129

2130

Returns:

2131

An object of the form:

2132

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2133

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

2134

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2135

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2136

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2137

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2138

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2139

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2140

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2141

"code": "A String", # [Output Only] The error type identifier for this error.

2142

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2143

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

},

2145

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2146

},

2147

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2148

"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.

2149

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2150

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2151

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2152

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2153

"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]

2154

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2155

"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.

2156

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2157

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2158

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2159

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2160

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2161

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2162

"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.

2163

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2164

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2165

{

2166

"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^]

2167

"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]

2168

{

2169

"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).

2170

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2171

},

2172

],

2173

"message": "A String", # [Output Only] A human-readable description of the warning code.

2174

},

2175

],

2176

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2177

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2181

<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2182

<pre>Retrieves the list of instances contained within the specified zone.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2183

2184

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

2185

project: string, Project ID for this request. (required)

2186

zone: string, The name of the zone for this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2187

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]

2188

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^]

2189

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]

2190

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]

2191

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^]

2192

x__xgafv: string, V1 error format.

2193

Allowed values

2194

1 - v1 error format

2195

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2196

2197

Returns:

2198

An object of the form:

2199

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2200

{ # Contains a list of instances.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2201

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2202

"items": [ # A list of Instance resources.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2203

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2204

"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.

2205

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

2206

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2207

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2208

"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]

2209

"confidentialInstanceConfig": { # A set of Confidential Instance options.

2210

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

2211

},

2212

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

2213

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2214

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

2215

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2216

"disks": [ # Array of disks associated with this instance. Persistent disks must be created before you can assign them.

2217

{ # An instance-attached disk resource.

2218

"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).

2219

"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^]

2220

"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.

2221

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2222

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2223

"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.

2224

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2225

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

2226

},

2227

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2228

"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]

2229

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2230

"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]

2231

},

2232

],

2233

"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^]

2234

"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]

2235

"description": "A String", # An optional description. Provide this property when creating the disk.

2236

"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.

2237

"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-16 00:22:06 -0700

[diff] [blame^]

2238

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2239

"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.

2240

"a_key": "A String",

2241

},

2242

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2243

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2244

"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.

2245

"A String",

2246

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2247

"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.

2248

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2249

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2250

"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.

2251

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2252

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2253

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2254

"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]

2255

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

2256

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

2257

"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.

2258

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

2259

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2260

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2261

},

2262

"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.

2263

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

2264

"licenses": [ # [Output Only] Any valid publicly visible licenses.

2265

"A String",

2266

],

2267

"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.

2268

"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

2269

"dbs": [ # The Key Database (db).

2270

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2271

"content": "A String", # The raw content in the secure keys file.

2272

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2273

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2274

],

2275

"dbxs": [ # The forbidden key database (dbx).

2276

{

2277

"content": "A String", # The raw content in the secure keys file.

2278

"fileType": "A String", # The file type of source file.

2279

},

2280

],

2281

"keks": [ # The Key Exchange Key (KEK).

2282

{

2283

"content": "A String", # The raw content in the secure keys file.

2284

"fileType": "A String", # The file type of source file.

2285

},

2286

],

2287

"pk": { # The Platform Key (PK).

2288

"content": "A String", # The raw content in the secure keys file.

2289

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2290

},

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

2291

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2292

"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]

2293

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2294

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2295

],

2296

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

2297

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

2298

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2299

"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]

2300

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

2301

{ # A specification of the type and number of accelerator cards attached to the instance.

2302

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

2303

"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.

2304

},

2305

],

2306

"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.

2307

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2308

"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^]

2309

"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]

2310

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

2311

"a_key": "A String",

2312

},

2313

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

2314

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

2315

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2316

"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]

2317

"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^]

2318

"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]

2319

"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^]

2320

{ # Metadata

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2321

"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.

2322

"value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2323

},

2324

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2325

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

2326

},

2327

"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".

2328

"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.

2329

"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.

2330

{ # A network interface resource attached to an instance.

2331

"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.

2332

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2333

"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.

2334

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2335

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2336

"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.

2337

"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^]

2338

"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]

2339

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2340

"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.

2341

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2342

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2343

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2344

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

2345

{ # An alias IP range attached to an instance's network interface.

2346

"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).

2347

"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.

2348

},

2349

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2350

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2351

"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.

2352

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

2353

"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.

2354

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

2355

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

2356

"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.

2357

"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^]

2358

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2359

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

2360

"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.

2361

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

2362

},

2363

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2364

"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]

2365

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

2366

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

2367

"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^]

2368

"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]

2369

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2370

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2371

"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.

2372

"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]

2373

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2374

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2375

"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]

2376

"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^]

2377

"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]

2378

"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]

2379

"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]

2380

"A String",

2381

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2382

},

2383

"resourcePolicies": [ # Resource policies applied to this instance.

2384

"A String",

2385

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2386

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

2387

"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^]

2388

"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]

2389

"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 Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2390

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

2391

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

2392

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

2393

"key": "A String", # Corresponds to the label key of Node resource.

2394

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

2395

"values": [ # Corresponds to the label values of Node resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

"A String",

],

},

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2400

"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.

2401

"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.

2402

},

2403

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2404

"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]

2405

{ # A service account.

2406

"email": "A String", # Email address of the service account.

2407

"scopes": [ # The list of scopes to be made available for this service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2408

"A String",

2409

],

2410

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2411

],

2412

"shieldedInstanceConfig": { # A set of Shielded Instance options.

2413

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

2414

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

2415

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

2416

},

2417

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

2418

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

2419

},

2420

"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^]

2421

"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]

2422

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

2423

"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^]

2424

"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]

2425

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2430

},

2431

],

2432

"kind": "compute#instanceList", # [Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.

2433

"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.

2434

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2435

"warning": { # [Output Only] Informational warning message.

2436

"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^]

2437

"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]

2438

{

2439

"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).

2440

"value": "A String", # [Output Only] A warning data value corresponding to the key.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2441

},

2442

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2443

"message": "A String", # [Output Only] A human-readable description of the warning code.

2444

},

2445

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2449

<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]

2450

<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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2451

2452

Args:

2453

project: string, Project ID for this request. (required)

2454

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2455

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^]

2456

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]

2457

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^]

2458

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]

2459

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]

2460

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^]

2461

x__xgafv: string, V1 error format.

2462

Allowed values

2463

1 - v1 error format

2464

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2465

2466

Returns:

2467

An object of the form:

2468

2469

{ # Contains a list of instance referrers.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2470

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2471

"items": [ # A list of Reference resources.

2472

{ # Represents a reference to a resource.

2473

"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^]

2474

"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]

2475

"referrer": "A String", # URL of the resource which refers to the target.

2476

"target": "A String", # URL of the resource to which this reference points.

2477

},

2478

],

2479

"kind": "compute#instanceListReferrers", # [Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.

2480

"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.

2481

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2482

"warning": { # [Output Only] Informational warning message.

2483

"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^]

2484

"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]

2485

{

2486

"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).

2487

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2488

},

2489

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2490

"message": "A String", # [Output Only] A human-readable description of the warning code.

2491

},

2492

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

<code class="details" id="listReferrers_next">listReferrers_next(previous_request, previous_response)</code>

2497

<pre>Retrieves the next page of results.

2498

2499

Args:

2500

previous_request: The request for the previous page. (required)

2501

previous_response: The response from the request for the previous page. (required)

2502

2503

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2504

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2505

page. Returns None if there are no more items in the collection.

</pre>

</div>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2510

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2511

<pre>Retrieves the next page of results.

2512

2513

Args:

2514

previous_request: The request for the previous page. (required)

2515

previous_response: The response from the request for the previous page. (required)

2516

2517

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2518

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2519

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^]

2524

<code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2525

<pre>Removes resource policies from an instance.

2526

2527

Args:

2528

project: string, Project ID for this request. (required)

2529

zone: string, The name of the zone for this request. (required)

2530

instance: string, The instance name for this request. (required)

2531

body: object, The request body.

2532

The object takes the form of:

2533

2534

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2535

"resourcePolicies": [ # Resource policies to be removed from this instance.

2536

"A String",

2537

],

2538

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2539

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2540

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).

2541

x__xgafv: string, V1 error format.

2542

Allowed values

2543

1 - v1 error format

2544

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2545

2546

Returns:

2547

An object of the form:

2548

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2549

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

2550

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2551

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2552

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2553

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2554

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2555

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2556

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2557

"code": "A String", # [Output Only] The error type identifier for this error.

2558

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2559

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2560

},

2561

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2562

},

2563

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2564

"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.

2565

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2566

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2567

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2568

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2569

"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]

2570

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2571

"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.

2572

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2573

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2574

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2575

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2576

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2577

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2578

"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.

2579

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2580

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2581

{

2582

"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^]

2583

"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]

2584

{

2585

"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).

2586

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2587

},

2588

],

2589

"message": "A String", # [Output Only] A human-readable description of the warning code.

2590

},

2591

],

2592

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2593

}</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^]

2597

<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]

2598

<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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2599

2600

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

2601

project: string, Project ID for this request. (required)

2602

zone: string, The name of the zone for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2603

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2604

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).

2605

x__xgafv: string, V1 error format.

2606

Allowed values

2607

1 - v1 error format

2608

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2609

2610

Returns:

2611

An object of the form:

2612

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2613

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

2614

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2615

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2616

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2617

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2618

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2619

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2620

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2621

"code": "A String", # [Output Only] The error type identifier for this error.

2622

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2623

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2624

},

2625

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2626

},

2627

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2628

"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.

2629

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2630

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2631

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2632

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2633

"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]

2634

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2635

"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.

2636

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2637

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2638

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2639

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2640

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2641

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2642

"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.

2643

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2644

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2645

{

2646

"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^]

2647

"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]

2648

{

2649

"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).

2650

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2651

},

2652

],

2653

"message": "A String", # [Output Only] A human-readable description of the warning code.

2654

},

2655

],

2656

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2657

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2661

<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]

2662

<pre>Sets deletion protection on the instance.

2663

2664

Args:

2665

project: string, Project ID for this request. (required)

2666

zone: string, The name of the zone for this request. (required)

2667

resource: string, Name or id of the resource for this request. (required)

2668

deletionProtection: boolean, Whether the resource should be protected against deletion.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2669

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).

2670

x__xgafv: string, V1 error format.

2671

Allowed values

2672

1 - v1 error format

2673

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2674

2675

Returns:

2676

An object of the form:

2677

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2678

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

2679

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2680

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2681

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2682

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2683

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2684

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2685

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2686

"code": "A String", # [Output Only] The error type identifier for this error.

2687

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2688

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2689

},

2690

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2691

},

2692

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2693

"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.

2694

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2695

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2696

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2697

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2698

"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]

2699

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2700

"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.

2701

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2702

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2703

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2704

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2705

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2706

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2707

"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.

2708

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2709

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2710

{

2711

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2712

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2713

{

2714

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

2715

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2716

},

2717

],

2718

"message": "A String", # [Output Only] A human-readable description of the warning code.

2719

},

2720

],

2721

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2722

}</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^]

2726

<code class="details" id="setDiskAutoDelete">setDiskAutoDelete(project, zone, instance, autoDelete, deviceName, requestId=None, x__xgafv=None)</code>

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

2727

<pre>Sets the auto-delete flag for a disk attached to an instance.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2728

2729

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

2730

project: string, Project ID for this request. (required)

2731

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2732

instance: string, The instance name for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2733

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]

2734

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^]

2735

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).

2736

x__xgafv: string, V1 error format.

2737

Allowed values

2738

1 - v1 error format

2739

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2740

2741

Returns:

2742

An object of the form:

2743

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2744

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

2745

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2746

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2747

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2748

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2749

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2750

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2751

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2752

"code": "A String", # [Output Only] The error type identifier for this error.

2753

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2754

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2755

},

2756

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2757

},

2758

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2759

"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.

2760

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2761

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2762

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2763

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2764

"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]

2765

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2766

"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.

2767

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2768

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2769

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2770

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2771

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2772

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2773

"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.

2774

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2775

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2776

{

2777

"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^]

2778

"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]

2779

{

2780

"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).

2781

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2782

},

2783

],

2784

"message": "A String", # [Output Only] A human-readable description of the warning code.

2785

},

2786

],

2787

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2788

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2792

<code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2793

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

2794

2795

Args:

2796

project: string, Project ID for this request. (required)

2797

zone: string, The name of the zone for this request. (required)

2798

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2799

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2800

The object takes the form of:

2801

2802

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2803

"bindings": [ # Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.

2804

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2805

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

2806

"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]

2807

"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.

2808

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2809

"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.

2810

"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.

2811

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2812

"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]

2813

"A String",

2814

],

2815

"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]

2816

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2817

],

2818

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2819

"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]

2820

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2821

{ # 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]

2822

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2823

{ # 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.

2824

"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]

2825

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2826

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2827

"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]

2828

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2829

},

2830

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2831

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2832

"A String",

2833

],

2834

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2835

},

2836

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2837

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2838

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2839

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

2840

"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]

2841

"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.

2842

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2843

"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.

2844

"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.

2845

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2846

"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]

2847

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2848

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2849

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2850

},

2851

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2852

"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.

2853

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

2854

"rules": [ # This is deprecated and has no effect. Do not use.

2855

{ # This is deprecated and has no effect. Do not use.

2856

"action": "A String", # This is deprecated and has no effect. Do not use.

2857

"conditions": [ # This is deprecated and has no effect. Do not use.

2858

{ # This is deprecated and has no effect. Do not use.

2859

"iam": "A String", # This is deprecated and has no effect. Do not use.

2860

"op": "A String", # This is deprecated and has no effect. Do not use.

2861

"svc": "A String", # This is deprecated and has no effect. Do not use.

2862

"sys": "A String", # This is deprecated and has no effect. Do not use.

2863

"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^]

2868

"description": "A String", # This is deprecated and has no effect. Do not use.

2869

"ins": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2870

"A String",

2871

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2872

"logConfigs": [ # This is deprecated and has no effect. Do not use.

2873

{ # This is deprecated and has no effect. Do not use.

2874

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2875

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2876

"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]

2877

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2878

"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]

2879

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2880

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2881

"customFields": [ # This is deprecated and has no effect. Do not use.

2882

{ # This is deprecated and has no effect. Do not use.

2883

"name": "A String", # This is deprecated and has no effect. Do not use.

2884

"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]

2885

},

2886

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2887

"field": "A String", # This is deprecated and has no effect. Do not use.

2888

"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]

2889

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2890

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2891

"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]

2892

},

2893

},

2894

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2895

"notIns": [ # This is deprecated and has no effect. Do not use.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2896

"A String",

2897

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2898

"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^]

2903

"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^]

2907

x__xgafv: string, V1 error format.

2908

Allowed values

2909

1 - v1 error format

2910

2 - v2 error format

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2911

2912

Returns:

2913

An object of the form:

2914

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2915

{ # 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]

2916

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2917

{ # 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]

2918

"auditLogConfigs": [ # The configuration for logging of each type of permission.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2919

{ # 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.

2920

"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]

2921

"A String",

2922

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2923

"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]

2924

"logType": "A String", # The log type that this config enables.

2925

},

2926

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2927

"exemptedMembers": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2928

"A String",

2929

],

2930

"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.

2931

},

2932

],

2933

"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.

2934

{ # Associates `members` with a `role`.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2935

"bindingId": "A String", # This is deprecated and has no effect. Do not use.

2936

"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]

2937

"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.

2938

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

2939

"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.

2940

"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.

2941

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2942

"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]

2943

"A String",

2944

],

2945

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

2946

},

2947

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2948

"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.

2949

"iamOwned": True or False, # This is deprecated and has no effect. Do not use.

2950

"rules": [ # This is deprecated and has no effect. Do not use.

2951

{ # This is deprecated and has no effect. Do not use.

2952

"action": "A String", # This is deprecated and has no effect. Do not use.

2953

"conditions": [ # This is deprecated and has no effect. Do not use.

2954

{ # This is deprecated and has no effect. Do not use.

2955

"iam": "A String", # This is deprecated and has no effect. Do not use.

2956

"op": "A String", # This is deprecated and has no effect. Do not use.

2957

"svc": "A String", # This is deprecated and has no effect. Do not use.

2958

"sys": "A String", # This is deprecated and has no effect. Do not use.

2959

"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^]

2964

"description": "A String", # This is deprecated and has no effect. Do not use.

2965

"ins": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2966

"A String",

2967

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2968

"logConfigs": [ # This is deprecated and has no effect. Do not use.

2969

{ # This is deprecated and has no effect. Do not use.

2970

"cloudAudit": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2971

"authorizationLoggingOptions": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2972

"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]

2973

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2974

"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]

2975

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2976

"counter": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2977

"customFields": [ # This is deprecated and has no effect. Do not use.

2978

{ # This is deprecated and has no effect. Do not use.

2979

"name": "A String", # This is deprecated and has no effect. Do not use.

2980

"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]

2981

},

2982

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2983

"field": "A String", # This is deprecated and has no effect. Do not use.

2984

"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]

2985

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2986

"dataAccess": { # This is deprecated and has no effect. Do not use. # This is deprecated and has no effect. Do not use.

2987

"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]

2988

},

2989

},

2990

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2991

"notIns": [ # This is deprecated and has no effect. Do not use.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2992

"A String",

2993

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2994

"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^]

2999

"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]

3000

}</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^]

3004

<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]

3005

<pre>Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3006

3007

Args:

3008

project: string, Project ID for this request. (required)

3009

zone: string, The name of the zone for this request. (required)

3010

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3011

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3012

The object takes the form of:

3013

3014

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3015

"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

2017-06-06 18:46:08 -0400

[diff] [blame]

3020

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3021

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).

3022

x__xgafv: string, V1 error format.

3023

Allowed values

3024

1 - v1 error format

3025

2 - v2 error format

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

3026

3027

Returns:

3028

An object of the form:

3029

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3030

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3031

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3032

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3033

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3034

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3035

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3036

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3037

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3038

"code": "A String", # [Output Only] The error type identifier for this error.

3039

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3040

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3041

},

3042

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3043

},

3044

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3045

"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.

3046

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3047

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3048

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3049

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3050

"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]

3051

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3052

"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.

3053

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3054

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3055

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3056

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3057

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3058

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3059

"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.

3060

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3061

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3062

{

3063

"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^]

3064

"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]

3065

{

3066

"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).

3067

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3068

},

3069

],

3070

"message": "A String", # [Output Only] A human-readable description of the warning code.

3071

},

3072

],

3073

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3074

}</pre>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3078

<code class="details" id="setMachineResources">setMachineResources(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3079

<pre>Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.

3080

3081

Args:

3082

project: string, Project ID for this request. (required)

3083

zone: string, The name of the zone for this request. (required)

3084

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3085

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3086

The object takes the form of:

3087

3088

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3089

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

3090

{ # A specification of the type and number of accelerator cards attached to the instance.

3091

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

3092

"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.

3093

},

3094

],

3095

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3096

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3097

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).

3098

x__xgafv: string, V1 error format.

3099

Allowed values

3100

1 - v1 error format

3101

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3102

3103

Returns:

3104

An object of the form:

3105

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3106

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3107

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3108

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3109

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3110

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3111

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3112

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3113

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3114

"code": "A String", # [Output Only] The error type identifier for this error.

3115

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3116

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3117

},

3118

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3119

},

3120

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3121

"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.

3122

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3123

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3124

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3125

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3126

"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]

3127

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3128

"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.

3129

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3130

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3131

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3132

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3133

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3134

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3135

"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.

3136

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3137

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3138

{

3139

"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^]

3140

"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]

3141

{

3142

"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).

3143

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3144

},

3145

],

3146

"message": "A String", # [Output Only] A human-readable description of the warning code.

3147

},

3148

],

3149

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3150

}</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^]

3154

<code class="details" id="setMachineType">setMachineType(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3155

<pre>Changes the machine type for a stopped instance to the machine type specified in the request.

3156

3157

Args:

3158

project: string, Project ID for this request. (required)

3159

zone: string, The name of the zone for this request. (required)

3160

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3161

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3162

The object takes the form of:

3163

3164

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3165

"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

3166

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3167

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3168

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).

3169

x__xgafv: string, V1 error format.

3170

Allowed values

3171

1 - v1 error format

3172

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3173

3174

Returns:

3175

An object of the form:

3176

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3177

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3178

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3179

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3180

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3181

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3182

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3183

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3184

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3185

"code": "A String", # [Output Only] The error type identifier for this error.

3186

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3187

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3188

},

3189

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3190

},

3191

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3192

"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.

3193

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3194

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3195

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3196

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3197

"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]

3198

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3199

"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.

3200

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3201

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3202

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3203

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3204

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3205

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3206

"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.

3207

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3208

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3209

{

3210

"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^]

3211

"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]

3212

{

3213

"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).

3214

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3215

},

3216

],

3217

"message": "A String", # [Output Only] A human-readable description of the warning code.

3218

},

3219

],

3220

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3221

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3225

<code class="details" id="setMetadata">setMetadata(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3226

<pre>Sets metadata for the specified instance to the data included in the request.

3227

3228

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

3229

project: string, Project ID for this request. (required)

3230

zone: string, The name of the zone for this request. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3231

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3232

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3233

The object takes the form of:

3234

3235

{ # A metadata key/value entry.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3236

"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]

3237

"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^]

3238

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3239

"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.

3240

"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).

3241

},

3242

],

3243

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3244

}

3245

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3246

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).

3247

x__xgafv: string, V1 error format.

3248

Allowed values

3249

1 - v1 error format

3250

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3251

3252

Returns:

3253

An object of the form:

3254

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3255

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3256

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3257

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3258

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3259

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3260

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3261

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3262

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3263

"code": "A String", # [Output Only] The error type identifier for this error.

3264

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3265

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3266

},

3267

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3268

},

3269

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3270

"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.

3271

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3272

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3273

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3274

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3275

"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]

3276

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3277

"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.

3278

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3279

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3280

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3281

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3282

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3283

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3284

"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.

3285

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3286

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3287

{

3288

"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^]

3289

"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]

3290

{

3291

"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).

3292

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3293

},

3294

],

3295

"message": "A String", # [Output Only] A human-readable description of the warning code.

3296

},

3297

],

3298

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3299

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3303

<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]

3304

<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.

3305

3306

Args:

3307

project: string, Project ID for this request. (required)

3308

zone: string, The name of the zone for this request. (required)

3309

instance: string, Name of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3310

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3311

The object takes the form of:

3312

3313

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3314

"minCpuPlatform": "A String", # Minimum cpu/platform this instance should be started at.

3315

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3316

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3317

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).

3318

x__xgafv: string, V1 error format.

3319

Allowed values

3320

1 - v1 error format

3321

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3322

3323

Returns:

3324

An object of the form:

3325

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3326

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3327

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3328

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3329

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3330

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3331

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3332

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3333

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3334

"code": "A String", # [Output Only] The error type identifier for this error.

3335

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3336

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3337

},

3338

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3339

},

3340

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3341

"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.

3342

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3343

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3344

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3345

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3346

"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]

3347

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3348

"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.

3349

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3350

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3351

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3352

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3353

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3354

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3355

"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.

3356

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3357

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3358

{

3359

"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^]

3360

"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]

3361

{

3362

"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).

3363

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3364

},

3365

],

3366

"message": "A String", # [Output Only] A human-readable description of the warning code.

3367

},

3368

],

3369

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3370

}</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^]

3374

<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]

3375

<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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3376

3377

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

3378

project: string, Project ID for this request. (required)

3379

zone: string, The name of the zone for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3380

instance: string, Instance name for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3381

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3382

The object takes the form of:

3383

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

3384

{ # Sets the scheduling options for an Instance. NextID: 21

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3385

"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]

3386

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3387

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3388

"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]

3389

{ # 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]

3390

"key": "A String", # Corresponds to the label key of Node resource.

3391

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

3392

"values": [ # Corresponds to the label values of Node resource.

3393

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3394

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3395

},

3396

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3397

"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]

3398

"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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3399

}

3400

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3401

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).

3402

x__xgafv: string, V1 error format.

3403

Allowed values

3404

1 - v1 error format

3405

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3406

3407

Returns:

3408

An object of the form:

3409

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3410

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3411

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3412

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3413

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3414

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3415

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3416

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3417

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3418

"code": "A String", # [Output Only] The error type identifier for this error.

3419

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3420

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3421

},

3422

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3423

},

3424

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3425

"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.

3426

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3427

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3428

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3429

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3430

"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]

3431

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3432

"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.

3433

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3434

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3435

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3436

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3437

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3438

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3439

"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.

3440

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3441

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3442

{

3443

"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^]

3444

"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]

3445

{

3446

"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).

3447

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3448

},

3449

],

3450

"message": "A String", # [Output Only] A human-readable description of the warning code.

3451

},

3452

],

3453

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3454

}</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^]

3458

<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]

3459

<pre>Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.

3460

3461

Args:

3462

project: string, Project ID for this request. (required)

3463

zone: string, The name of the zone for this request. (required)

3464

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3465

body: object, The request body.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3466

The object takes the form of:

3467

3468

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3469

"email": "A String", # Email address of the service account.

3470

"scopes": [ # The list of scopes to be made available for this service account.

3471

"A String",

3472

],

3473

}

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3474

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3475

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).

3476

x__xgafv: string, V1 error format.

3477

Allowed values

3478

1 - v1 error format

3479

2 - v2 error format

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

3480

3481

Returns:

3482

An object of the form:

3483

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3484

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3485

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3486

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3487

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3488

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3489

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3490

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3491

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3492

"code": "A String", # [Output Only] The error type identifier for this error.

3493

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3494

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3495

},

3496

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3497

},

3498

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3499

"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.

3500

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3501

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3502

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3503

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3504

"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]

3505

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3506

"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.

3507

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3508

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3509

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3510

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3511

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3512

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3513

"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.

3514

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3515

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3516

{

3517

"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^]

3518

"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]

3519

{

3520

"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).

3521

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3522

},

3523

],

3524

"message": "A String", # [Output Only] A human-readable description of the warning code.

3525

},

3526

],

3527

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3528

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3532

<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]

3533

<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.

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 or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3539

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3540

The object takes the form of:

3541

3542

{ # The policy describes the baseline against which Instance boot integrity is measured.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3543

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

3544

}

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3545

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3546

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).

3547

x__xgafv: string, V1 error format.

3548

Allowed values

3549

1 - v1 error format

3550

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

3551

3552

Returns:

3553

An object of the form:

3554

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3555

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3556

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3557

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3558

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3559

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3560

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3561

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3562

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3563

"code": "A String", # [Output Only] The error type identifier for this error.

3564

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3565

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3566

},

3567

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3568

},

3569

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3570

"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.

3571

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3572

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3573

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3574

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3575

"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]

3576

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3577

"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.

3578

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3579

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3580

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3581

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3582

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3583

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3584

"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.

3585

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3586

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3587

{

3588

"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^]

3589

"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]

3590

{

3591

"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).

3592

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3593

},

3594

],

3595

"message": "A String", # [Output Only] A human-readable description of the warning code.

3596

},

3597

],

3598

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3599

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3603

<code class="details" id="setTags">setTags(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3604

<pre>Sets network tags for the specified instance to the data included in the request.

3605

3606

Args:

3607

project: string, Project ID for this request. (required)

3608

zone: string, The name of the zone for this request. (required)

3609

instance: string, Name of the instance scoping this request. (required)

3610

body: object, The request body.

3611

The object takes the form of:

3612

3613

{ # A set of instance tags.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3614

"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]

3615

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

}

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3620

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).

3621

x__xgafv: string, V1 error format.

3622

Allowed values

3623

1 - v1 error format

3624

2 - v2 error format

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3625

3626

Returns:

3627

An object of the form:

3628

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3629

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3630

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3631

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3632

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3633

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3634

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3635

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3636

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3637

"code": "A String", # [Output Only] The error type identifier for this error.

3638

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3639

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3640

},

3641

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3642

},

3643

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3644

"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.

3645

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3646

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3647

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3648

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3649

"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]

3650

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3651

"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.

3652

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3653

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3654

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3655

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3656

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3657

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3658

"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.

3659

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3660

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3661

{

3662

"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^]

3663

"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]

3664

{

3665

"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).

3666

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3667

},

3668

],

3669

"message": "A String", # [Output Only] A human-readable description of the warning code.

3670

},

3671

],

3672

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3673

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3677

<code class="details" id="simulateMaintenanceEvent">simulateMaintenanceEvent(project, zone, instance, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3678

<pre>Simulates a maintenance event on the instance.

3679

3680

Args:

3681

project: string, Project ID for this request. (required)

3682

zone: string, The name of the zone for this request. (required)

3683

instance: string, Name of the instance scoping this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3684

x__xgafv: string, V1 error format.

3685

Allowed values

3686

1 - v1 error format

3687

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3688

3689

Returns:

3690

An object of the form:

3691

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3692

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3693

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3694

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3695

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3696

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3697

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3698

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3699

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3700

"code": "A String", # [Output Only] The error type identifier for this error.

3701

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3702

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3703

},

3704

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3705

},

3706

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3707

"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.

3708

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3709

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3710

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3711

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3712

"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]

3713

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3714

"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.

3715

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3716

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3717

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3718

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3719

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3720

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3721

"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.

3722

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3723

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3724

{

3725

"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^]

3726

"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]

3727

{

3728

"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).

3729

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3730

},

3731

],

3732

"message": "A String", # [Output Only] A human-readable description of the warning code.

3733

},

3734

],

3735

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3736

}</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^]

3740

<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]

3741

<pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

3742

3743

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

3744

project: string, Project ID for this request. (required)

3745

zone: string, The name of the zone for this request. (required)

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

3746

instance: string, Name of the instance resource to start. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3747

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).

3748

x__xgafv: string, V1 error format.

3749

Allowed values

3750

1 - v1 error format

3751

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

3752

3753

Returns:

3754

An object of the form:

3755

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3756

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3757

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3758

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3759

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3760

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3761

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3762

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3763

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3764

"code": "A String", # [Output Only] The error type identifier for this error.

3765

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3766

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3767

},

3768

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3769

},

3770

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3771

"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.

3772

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3773

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3774

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3775

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3776

"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]

3777

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3778

"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.

3779

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3780

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3781

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3782

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3783

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3784

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3785

"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.

3786

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3787

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3788

{

3789

"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^]

3790

"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]

3791

{

3792

"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).

3793

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3794

},

3795

],

3796

"message": "A String", # [Output Only] A human-readable description of the warning code.

3797

},

3798

],

3799

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3800

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3804

<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]

3805

<pre>Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3806

3807

Args:

3808

project: string, Project ID for this request. (required)

3809

zone: string, The name of the zone for this request. (required)

3810

instance: string, Name of the instance resource to start. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3811

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3812

The object takes the form of:

3813

3814

{

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3815

"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]

3816

{

3817

"diskEncryptionKey": { # Decrypts data associated with the disk with a customer-supplied encryption key.

3818

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

3819

"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.

3820

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

3821

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3822

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3823

"source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

3824

},

3825

],

3826

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3827

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3828

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).

3829

x__xgafv: string, V1 error format.

3830

Allowed values

3831

1 - v1 error format

3832

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

3833

3834

Returns:

3835

An object of the form:

3836

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3837

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3838

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3839

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3840

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3841

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3842

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3843

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3844

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3845

"code": "A String", # [Output Only] The error type identifier for this error.

3846

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3847

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3848

},

3849

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3850

},

3851

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3852

"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.

3853

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3854

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3855

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3856

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3857

"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]

3858

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3859

"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.

3860

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3861

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3862

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3863

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3864

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3865

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3866

"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.

3867

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3868

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3869

{

3870

"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^]

3871

"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]

3872

{

3873

"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).

3874

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3875

},

3876

],

3877

"message": "A String", # [Output Only] A human-readable description of the warning code.

3878

},

3879

],

3880

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3881

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3885

<code class="details" id="stop">stop(project, zone, instance, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3886

<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.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

3887

3888

Args:

Nathaniel Manista

2015-03-10 23:29:22 +0000

[diff] [blame]

3889

project: string, Project ID for this request. (required)

3890

zone: string, The name of the zone for this request. (required)

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

3891

instance: string, Name of the instance resource to stop. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3892

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).

3893

x__xgafv: string, V1 error format.

3894

Allowed values

3895

1 - v1 error format

3896

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

3897

3898

Returns:

3899

An object of the form:

3900

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3901

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

3902

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3903

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3904

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3905

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3906

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3907

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3908

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3909

"code": "A String", # [Output Only] The error type identifier for this error.

3910

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3911

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3912

},

3913

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3914

},

3915

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3916

"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.

3917

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3918

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3919

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3920

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3921

"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]

3922

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3923

"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.

3924

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3925

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3926

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3927

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3928

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3929

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3930

"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.

3931

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3932

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3933

{

3934

"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^]

3935

"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]

3936

{

3937

"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).

3938

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3939

},

3940

],

3941

"message": "A String", # [Output Only] A human-readable description of the warning code.

3942

},

3943

],

3944

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3945

}</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^]

3949

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3950

<pre>Returns permissions that a caller has on the specified resource.

3951

3952

Args:

3953

project: string, Project ID for this request. (required)

3954

zone: string, The name of the zone for this request. (required)

3955

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3956

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3957

The object takes the form of:

3958

3959

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3960

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

3961

"A String",

3962

],

3963

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3964

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3965

x__xgafv: string, V1 error format.

3966

Allowed values

3967

1 - v1 error format

3968

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3969

3970

Returns:

3971

An object of the form:

3972

3973

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3974

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

3975

"A String",

3976

],

3977

}</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^]

3981

<code class="details" id="update">update(project, zone, instance, body=None, minimalAction=None, mostDisruptiveAllowedAction=None, requestId=None, x__xgafv=None)</code>

3982

<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]

3983

3984

Args:

3985

project: string, Project ID for this request. (required)

3986

zone: string, The name of the zone for this request. (required)

3987

instance: string, Name of the instance resource to update. (required)

3988

body: object, The request body.

3989

The object takes the form of:

3990

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3991

{ # Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3992

"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.

3993

"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false).

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

3994

"threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3995

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3996

"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 .

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3997

"confidentialInstanceConfig": { # A set of Confidential Instance options.

3998

"enableConfidentialCompute": True or False, # Defines whether the instance should have confidential compute enabled.

3999

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4000

"cpuPlatform": "A String", # [Output Only] The CPU platform used by this instance.

4001

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4002

"deletionProtection": True or False, # Whether the resource should be protected against deletion.

4003

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4004

"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]

4005

{ # An instance-attached disk resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4006

"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).

4007

"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^]

4008

"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.

4009

"diskEncryptionKey": { # Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4010

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4011

"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.

4012

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4013

"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]

4014

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4015

"diskSizeGb": "A String", # The size of the disk in GB.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4016

"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]

4017

{ # Guest OS features.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4018

"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]

4019

},

4020

],

4021

"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^]

4022

"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]

4023

"description": "A String", # An optional description. Provide this property when creating the disk.

4024

"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.

4025

"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-16 00:22:06 -0700

[diff] [blame^]

4026

"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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4027

"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.

4028

"a_key": "A String",

4029

},

4030

"onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default is to use the existing disk.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4031

"provisionedIops": "A String", # Indicates how many IOPS must be provisioned for the disk.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4032

"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.

4033

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4034

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4035

"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.

4036

"sourceImageEncryptionKey": { # The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4037

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4038

"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.

4039

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4040

"sha256": "A String", # [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

4041

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4042

"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]

4043

"sourceSnapshotEncryptionKey": { # The customer-supplied encryption key of the source snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4044

"kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.

4045

"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.

4046

"rawKey": "A String", # Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

4047

"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]

4048

},

4049

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4050

"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.

4051

"kind": "compute#attachedDisk", # [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

4052

"licenses": [ # [Output Only] Any valid publicly visible licenses.

4053

"A String",

4054

],

4055

"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.

4056

"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

4057

"dbs": [ # The Key Database (db).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4058

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4059

"content": "A String", # The raw content in the secure keys file.

4060

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4061

},

4062

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4063

"dbxs": [ # The forbidden key database (dbx).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4064

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4065

"content": "A String", # The raw content in the secure keys file.

4066

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4067

},

4068

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4069

"keks": [ # The Key Exchange Key (KEK).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4070

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4071

"content": "A String", # The raw content in the secure keys file.

4072

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4073

},

4074

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4075

"pk": { # The Platform Key (PK).

4076

"content": "A String", # The raw content in the secure keys file.

4077

"fileType": "A String", # The file type of source file.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4078

},

4079

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4080

"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]

4081

"type": "A String", # Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4082

},

4083

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4084

"displayDevice": { # A set of Display Device options # Enables display device for the instance.

4085

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

4086

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4087

"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]

4088

"guestAccelerators": [ # A list of the type and count of accelerator cards attached to the instance.

4089

{ # A specification of the type and number of accelerator cards attached to the instance.

4090

"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.

4091

"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.

4092

},

4093

],

4094

"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.

4095

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4096

"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^]

4097

"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]

4098

"labels": { # Labels to apply to this instance. These can be later modified by the setLabels method.

4099

"a_key": "A String",

4100

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

4101

"lastStartTimestamp": "A String", # [Output Only] Last start timestamp in RFC3339 text format.

4102

"lastStopTimestamp": "A String", # [Output Only] Last stop timestamp in RFC3339 text format.

4103

"lastSuspendedTimestamp": "A String", # [Output Only] Last suspended timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4104

"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]

4105

"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^]

4106

"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]

4107

"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^]

4108

{ # Metadata

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4109

"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.

4110

"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).

4111

},

4112

],

4113

"kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata.

4114

},

4115

"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".

4116

"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.

4117

"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.

4118

{ # A network interface resource attached to an instance.

4119

"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.

4120

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4121

"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.

4122

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4123

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4124

"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.

4125

"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^]

4126

"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]

4127

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4128

"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.

4129

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4130

},

4131

],

4132

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4133

{ # An alias IP range attached to an instance's network interface.

4134

"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).

4135

"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.

4136

},

4137

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4138

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4139

"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.

4140

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4141

"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.

4142

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4143

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4144

"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.

4145

"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^]

4146

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4147

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4148

"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.

4149

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4150

},

4151

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4152

"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-07-22 17:02:09 -0700

[diff] [blame]

4153

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4154

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4155

"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^]

4156

"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]

4157

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4158

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4159

"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.

4160

"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]

4161

},

4162

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4163

"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]

4164

"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^]

4165

"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]

4166

"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]

4167

"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.

4172

"A String",

4173

],

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4174

"satisfiesPzs": True or False, # [Output Only] Reserved for future use.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4175

"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^]

4176

"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]

4177

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4178

"minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4179

"nodeAffinities": [ # A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

4180

{ # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

4181

"key": "A String", # Corresponds to the label key of Node resource.

4182

"operator": "A String", # Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.

4183

"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]

4189

"preemptible": True or False, # Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a `TERMINATED` state. See Instance Life Cycle for more information on the possible instance states.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4190

},

4191

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4192

"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]

4193

{ # A service account.

4194

"email": "A String", # Email address of the service account.

4195

"scopes": [ # The list of scopes to be made available for this service account.

"A String",

],

},

],

"shieldedInstanceConfig": { # A set of Shielded Instance options.

4201

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4202

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4203

"enableVtpm": True or False, # Defines whether the instance has the vTPM enabled. Enabled by default.

4204

},

4205

"shieldedInstanceIntegrityPolicy": { # The policy describes the baseline against which Instance boot integrity is measured.

4206

"updateAutoLearnPolicy": True or False, # Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.

4207

},

4208

"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^]

4209

"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]

4210

"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.

4211

"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^]

4212

"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]

4213

"items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

"A String",

],

},

"zone": "A String", # [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4218

}

4219

4220

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.

4221

Allowed values

4222

INVALID -

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4223

NO_EFFECT - No changes can be made to the instance.

4224

REFRESH - The instance will not restart.

4225

RESTART - The instance will restart.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4226

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.

4227

Allowed values

4228

INVALID -

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4229

NO_EFFECT - No changes can be made to the instance.

4230

REFRESH - The instance will not restart.

4231

RESTART - The instance will restart.

4232

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).

4233

x__xgafv: string, V1 error format.

4234

Allowed values

4235

1 - v1 error format

4236

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4237

4238

Returns:

4239

An object of the form:

4240

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4241

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

4242

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4243

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4244

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4245

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4246

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4247

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4248

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4249

"code": "A String", # [Output Only] The error type identifier for this error.

4250

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4251

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4252

},

4253

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4254

},

4255

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4256

"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.

4257

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4258

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4259

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4260

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4261

"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]

4262

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4263

"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.

4264

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4265

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4266

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4267

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4268

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4269

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4270

"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.

4271

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4272

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4273

{

4274

"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^]

4275

"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]

4276

{

4277

"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).

4278

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4279

},

4280

],

4281

"message": "A String", # [Output Only] A human-readable description of the warning code.

4282

},

4283

],

4284

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4285

}</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^]

4289

<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]

4290

<pre>Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4291

4292

Args:

4293

project: string, Project ID for this request. (required)

4294

zone: string, The name of the zone for this request. (required)

4295

instance: string, The instance name for this request. (required)

4296

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]

4297

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4298

The object takes the form of:

4299

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4300

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4301

"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.

4302

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4303

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4304

"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.

4305

"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^]

4306

"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]

4307

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4308

"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.

4309

"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]

4310

}

4311

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4312

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).

4313

x__xgafv: string, V1 error format.

4314

Allowed values

4315

1 - v1 error format

4316

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4317

4318

Returns:

4319

An object of the form:

4320

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4321

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

4322

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4323

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4324

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4325

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4326

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4327

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4328

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4329

"code": "A String", # [Output Only] The error type identifier for this error.

4330

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4331

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4332

},

4333

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4334

},

4335

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4336

"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.

4337

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4338

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4339

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4340

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4341

"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]

4342

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4343

"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.

4344

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4345

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4346

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4347

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4348

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4349

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4350

"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.

4351

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4352

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4353

{

4354

"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^]

4355

"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]

4356

{

4357

"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).

4358

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4359

},

4360

],

4361

"message": "A String", # [Output Only] A human-readable description of the warning code.

4362

},

4363

],

4364

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4365

}</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^]

4369

<code class="details" id="updateDisplayDevice">updateDisplayDevice(project, zone, instance, body=None, requestId=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4370

<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.

4371

4372

Args:

4373

project: string, Project ID for this request. (required)

4374

zone: string, The name of the zone for this request. (required)

4375

instance: string, Name of the instance scoping this request. (required)

4376

body: object, The request body.

4377

The object takes the form of:

4378

4379

{ # A set of Display Device options

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4380

"enableDisplay": True or False, # Defines whether the instance has Display enabled.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4381

}

4382

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4383

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).

4384

x__xgafv: string, V1 error format.

4385

Allowed values

4386

1 - v1 error format

4387

2 - v2 error format

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4388

4389

Returns:

4390

An object of the form:

4391

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4392

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

4393

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4394

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4395

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4396

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4397

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4398

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4399

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4400

"code": "A String", # [Output Only] The error type identifier for this error.

4401

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4402

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4403

},

4404

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4405

},

4406

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4407

"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.

4408

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4409

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4410

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4411

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4412

"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]

4413

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4414

"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.

4415

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4416

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4417

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4418

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4419

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4420

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4421

"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.

4422

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4423

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4424

{

4425

"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^]

4426

"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]

4427

{

4428

"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).

4429

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4430

},

4431

],

4432

"message": "A String", # [Output Only] A human-readable description of the warning code.

4433

},

4434

],

4435

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4436

}</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^]

4440

<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]

4441

<pre>Updates an instance's network interface. This method can only update an interface's alias IP range and attached network. See Modifying alias IP ranges for an existing instance for instructions on changing alias IP ranges. See Migrating a VM between networks for instructions on migrating an interface. This method follows PATCH semantics.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4442

4443

Args:

4444

project: string, Project ID for this request. (required)

4445

zone: string, The name of the zone for this request. (required)

4446

instance: string, The instance name for this request. (required)

4447

networkInterface: string, The name of the network interface to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4448

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4449

The object takes the form of:

4450

4451

{ # A network interface resource attached to an instance.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4452

"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.

4453

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4454

"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.

4455

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4456

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4457

"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.

4458

"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^]

4459

"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]

4460

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4461

"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.

4462

"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]

4463

},

4464

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4465

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

4466

{ # An alias IP range attached to an instance's network interface.

4467

"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).

4468

"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.

4469

},

4470

],

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4471

"fingerprint": "A String", # Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4472

"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.

4473

{ # An access configuration attached to an instance's network interface. Only one access config per instance is supported.

4474

"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.

4475

"externalIpv6PrefixLength": 42, # [Output Only] The prefix length of the external IPv6 range.

4476

"kind": "compute#accessConfig", # [Output Only] Type of the resource. Always compute#accessConfig for access configs.

4477

"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.

4478

"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^]

4479

"networkTier": "A String", # This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.

yoshi-code-bot

2021-05-16 02:16:04 -0700

[diff] [blame]

4480

"publicPtrDomainName": "A String", # The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.

4481

"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.

4482

"type": "ONE_TO_ONE_NAT", # The type of configuration. The default and only option is ONE_TO_ONE_NAT.

4483

},

4484

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4485

"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-07-22 17:02:09 -0700

[diff] [blame]

4486

"ipv6Address": "A String", # [Output Only] An IPv6 internal network address for this network interface.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4487

"kind": "compute#networkInterface", # [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

4488

"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^]

4489

"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]

4490

"networkIP": "A String", # An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4491

"nicType": "A String", # The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4492

"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.

4493

"subnetwork": "A String", # The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4494

}

4495

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4496

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).

4497

x__xgafv: string, V1 error format.

4498

Allowed values

4499

1 - v1 error format

4500

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4501

4502

Returns:

4503

An object of the form:

4504

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4505

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

4506

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4507

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4508

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4509

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4510

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4511

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4512

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4513

"code": "A String", # [Output Only] The error type identifier for this error.

4514

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4515

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4516

},

4517

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4518

},

4519

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4520

"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.

4521

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4522

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4523

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4524

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4525

"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]

4526

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4527

"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.

4528

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4529

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4530

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4531

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4532

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4533

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4534

"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.

4535

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4536

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4537

{

4538

"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^]

4539

"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]

4540

{

4541

"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).

4542

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4543

},

4544

],

4545

"message": "A String", # [Output Only] A human-readable description of the warning code.

4546

},

4547

],

4548

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

4549

}</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^]

4553

<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]

4554

<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.

4555

4556

Args:

4557

project: string, Project ID for this request. (required)

4558

zone: string, The name of the zone for this request. (required)

4559

instance: string, Name or id of the instance scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4560

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4561

The object takes the form of:

4562

4563

{ # A set of Shielded Instance options.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4564

"enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled. Enabled by default.

4565

"enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled. Disabled by default.

4566

"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]

4567

}

4568

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4569

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).

4570

x__xgafv: string, V1 error format.

4571

Allowed values

4572

1 - v1 error format

4573

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4574

4575

Returns:

4576

An object of the form:

4577

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4578

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]

4579

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4580

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4581

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4582

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4583

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4584

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4585

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4586

"code": "A String", # [Output Only] The error type identifier for this error.

4587

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4588

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4589

},

4590

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4591

},

4592

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4593

"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.

4594

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4595

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4596

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4597

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4598

"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]

4599

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4600

"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.

4601

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4602

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4603

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4604

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4605

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4606

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4607

"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.

4608

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4609

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4610

{

4611

"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^]

4612

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot