Reference documentation and code samples for the Compute V1 Client class BulkInsertInstanceResource.
A transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests.
Generated from protobuf messagegoogle.cloud.compute.v1.BulkInsertInstanceResource
Policy for choosing target zone. For more information, see Create VMs in bulk.
↳ min_count
int|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.
↳ name_pattern
string
The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.
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.
↳ source_instance_template
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.
getCount
The maximum number of instances to create.
Returns
Type
Description
int|string
hasCount
clearCount
setCount
The maximum number of instances to create.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getInstanceProperties
The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.
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.
Returns
Type
Description
int|string
hasMinCount
clearMinCount
setMinCount
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.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getNamePattern
The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.
Returns
Type
Description
string
hasNamePattern
clearNamePattern
setNamePattern
The string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPerInstanceProperties
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.
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.
Returns
Type
Description
string
hasSourceInstanceTemplate
clearSourceInstanceTemplate
setSourceInstanceTemplate
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class BulkInsertInstanceResource (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.BulkInsertInstanceResource)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.BulkInsertInstanceResource)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.BulkInsertInstanceResource)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.BulkInsertInstanceResource)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.BulkInsertInstanceResource)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.BulkInsertInstanceResource)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.BulkInsertInstanceResource)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.BulkInsertInstanceResource)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.BulkInsertInstanceResource)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.BulkInsertInstanceResource)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.BulkInsertInstanceResource)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.BulkInsertInstanceResource)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.BulkInsertInstanceResource)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.BulkInsertInstanceResource)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.BulkInsertInstanceResource)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.BulkInsertInstanceResource)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.BulkInsertInstanceResource)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.BulkInsertInstanceResource)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.BulkInsertInstanceResource)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.BulkInsertInstanceResource)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.BulkInsertInstanceResource)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.BulkInsertInstanceResource)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.BulkInsertInstanceResource)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.BulkInsertInstanceResource)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.BulkInsertInstanceResource)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.BulkInsertInstanceResource)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.BulkInsertInstanceResource)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.BulkInsertInstanceResource)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.BulkInsertInstanceResource)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.BulkInsertInstanceResource) \nReference documentation and code samples for the Compute V1 Client class BulkInsertInstanceResource.\n\nA transient resource used in compute.instances.bulkInsert and compute.regionInstances.bulkInsert . This resource is not persisted anywhere, it is used only for processing the requests.\n\nGenerated from protobuf message `google.cloud.compute.v1.BulkInsertInstanceResource`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCount\n\nThe maximum number of instances to create.\n\n### hasCount\n\n### clearCount\n\n### setCount\n\nThe maximum number of instances to create.\n\n### getInstanceProperties\n\nThe instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.\n\n### hasInstanceProperties\n\n### clearInstanceProperties\n\n### setInstanceProperties\n\nThe instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.\n\n### getLocationPolicy\n\nPolicy for choosing target zone. For more information, see Create VMs in bulk.\n\n### hasLocationPolicy\n\n### clearLocationPolicy\n\n### setLocationPolicy\n\nPolicy for choosing target zone. For more information, see Create VMs in bulk.\n\n### getMinCount\n\nThe 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.\n\n### hasMinCount\n\n### clearMinCount\n\n### setMinCount\n\nThe 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.\n\n### getNamePattern\n\nThe string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.\n\n### hasNamePattern\n\n### clearNamePattern\n\n### setNamePattern\n\nThe string pattern used for the names of the VMs. Either name_pattern or per_instance_properties must be set. The pattern must contain one continuous sequence of placeholder hash characters (#) with each character corresponding to one digit of the generated instance name. Example: a name_pattern of inst-#### generates instance names such as inst-0001 and inst-0002. If existing instances in the same project and zone have names that match the name pattern then the generated instance numbers start after the biggest existing number. For example, if there exists an instance with name inst-0050, then instance names generated using the pattern inst-#### begin with inst-0051. The name pattern placeholder #...# can contain up to 18 characters.\n\n### getPerInstanceProperties\n\nPer-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.\n\n### setPerInstanceProperties\n\nPer-instance properties to be set on individual instances. Keys of this map specify requested instance names. Can be empty if name_pattern is used.\n\n### getSourceInstanceTemplate\n\nSpecifies 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: - \u003chttps://www.googleapis.com/compute/v1/projects/project\u003e /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional.\n\n### hasSourceInstanceTemplate\n\n### clearSourceInstanceTemplate\n\n### setSourceInstanceTemplate\n\nSpecifies 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: - \u003chttps://www.googleapis.com/compute/v1/projects/project\u003e /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate This field is optional."]]
