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

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

b6dc1b9

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

[diff] [blame]

95

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

96

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

97

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

98

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

Anthonios Partheniou

10f4b67

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

[diff] [blame]

99

"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

b6dc1b9

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

[diff] [blame]

100

},

101

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

102

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

103

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

104

},

105

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

106

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

107

{ # An instance-attached disk resource.

108

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

109

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

110

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

111

#

112

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

113

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

114

#

115

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

116

#

117

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

118

#

119

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

120

#

121

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

122

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

123

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

124

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

125

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

126

#

127

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

128

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

129

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

130

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

131

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

132

},

133

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

134

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

135

{ # Guest OS features.

136

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

137

},

138

],

139

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

140

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

141

#

142

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

143

#

144

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

145

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

146

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

147

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

148

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

149

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

150

#

151

#

152

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

153

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

154

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

155

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

156

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

157

#

158

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

159

{ # Guest OS features.

160

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

161

},

162

],

163

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

164

"a_key": "A String",

165

},

166

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

167

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

168

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

169

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

170

"A String",

171

],

172

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

173

#

174

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

175

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

176

#

177

#

178

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

179

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

180

#

181

#

182

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

183

# global/images/my-custom-image

184

#

185

#

186

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

187

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

188

#

189

#

190

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

191

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

192

#

193

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

194

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

195

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

196

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

197

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

198

#

199

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

200

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

201

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

202

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

203

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

204

},

205

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

206

#

207

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

208

# global/snapshots/my-backup

209

#

210

#

211

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

212

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

213

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

214

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

215

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

216

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

217

#

218

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

219

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

220

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

221

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

222

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

223

},

224

},

225

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

226

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

227

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

228

"A String",

229

],

230

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

231

"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

232

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

233

{

234

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

235

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

236

},

237

],

238

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

239

{

240

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

241

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

242

},

243

],

244

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

245

{

246

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

247

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

248

},

249

],

250

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

251

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

252

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

253

},

254

},

255

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

256

#

257

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

258

#

259

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

260

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

261

},

262

],

263

"displayDevice": { # A set of Display Device options # Display Device properties to enable support for remote display products like: Teradici, VNC and TeamViewer

264

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

265

},

266

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

267

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

268

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

269

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

270

},

271

],

272

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

273

"a_key": "A String",

274

},

275

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

276

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

277

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

278

#

279

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

280

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

281

{

282

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

283

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

284

},

285

],

286

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

287

},

288

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

289

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

290

{ # A network interface resource attached to an instance.

291

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

292

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

yoshi-code-bot

c2cd326

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

[diff] [blame^]

293

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

294

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

295

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

296

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

297

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

298

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

299

#

300

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

301

#

302

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

303

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

304

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

305

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

306

},

307

],

308

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

309

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

310

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

311

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

312

},

313

],

yoshi-code-bot

a8b35b9

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

[diff] [blame]

314

"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

c2cd326

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

[diff] [blame^]

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

#

324

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

325

#

326

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

327

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

328

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

329

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

330

},

331

],

332

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

333

#

334

# Valid only if stackType is IPV4_IPV6.

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

335

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

336

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

337

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

338

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

339

#

340

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

341

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

342

# - projects/project/global/networks/network

343

# - global/networks/default

344

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

345

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

yoshi-code-bot

c2cd326

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

[diff] [blame^]

346

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

347

#

348

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

349

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

350

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

351

# - regions/region/subnetworks/subnetwork

352

},

353

],

354

"networkPerformanceConfig": {

355

"totalEgressBandwidthTier": "A String",

356

},

357

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

358

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

359

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

360

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

361

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

362

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

"A String",

],

},

"resourcePolicies": [ # Resource policies (names, not ULRs) applied to instances created from these properties.

367

"A String",

368

],

yoshi-code-bot

c2cd326

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

[diff] [blame^]

369

"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

b6dc1b9

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

[diff] [blame]

370

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

371

#

372

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

373

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

yoshi-code-bot

9e2cde2

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

[diff] [blame]

374

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

375

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

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

376

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

377

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

378

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

379

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

380

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

381

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

387

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

388

},

389

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

390

{ # A service account.

391

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

392

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

"A String",

],

},

],

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

398

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

399

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

400

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

401

},

402

"shieldedVmConfig": { # A set of Shielded VM options. # Specifies the Shielded VM options for the instances that are created from these properties.

403

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

404

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

405

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

406

},

407

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

408

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

409

#

410

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

411

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

"A String",

],

},

},

Anthonios Partheniou

10f4b67

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

[diff] [blame]

416

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

417

"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

b6dc1b9

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

[diff] [blame]

418

"a_key": {

yoshi-code-bot

c2cd326

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

[diff] [blame^]

419

"preference": "A String", # Preference for a given location: ALLOW or DENY.

yoshi-code-bot

b6dc1b9

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

[diff] [blame]

420

},

421

},

422

},

Anthonios Partheniou

10f4b67

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

[diff] [blame]

423

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

424

"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

b6dc1b9

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

[diff] [blame]

425

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

426

"a_key": { # Per-instance properties to be set on individual instances. To be extended in the future.

427

"name": "A String", # This field is only temporary. It will be removed. Do not use it.

428

},

429

},

430

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

431

#

432

# It can be a full or partial URL. For example, the following are all valid URLs to an instance template:

433

# - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate

434

# - projects/project/global/instanceTemplates/instanceTemplate

435

# - global/instanceTemplates/instanceTemplate

436

#

437

# This field is optional.

438

}

439

440

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.

441

442

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.

443

444

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

445

446

Returns:

447

An object of the form:

448

449

{ # Represents an Operation resource.

450

#

451

# Google Compute Engine has three Operation resources:

452

#

453

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

454

#

455

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

456

#

457

# Operations can be global, regional or zonal.

458

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

459

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

460

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

461

#

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

{

470

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

471

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

472

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

477

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

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

{

495

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

496

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

497

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

498

{

499

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

500

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

501

},

502

],

503

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

504

},

505

],