target.apidocs.com.google.api.services.compute.model.BulkInsertInstanceResource.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







BulkInsertInstanceResource (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class BulkInsertInstanceResource



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.BulkInsertInstanceResource













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class BulkInsertInstanceResource
extends com.google.api.client.json.GenericJson
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.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


BulkInsertInstanceResource() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BulkInsertInstanceResource
clone() 


Long
getCount()
The maximum number of instances to create.



InstanceProperties
getInstanceProperties()
The instance properties defining the VM instances to be created.



LocationPolicy
getLocationPolicy()
Policy for choosing target zone.



Long
getMinCount()
The minimum number of instances to create.



String
getNamePattern()
The string pattern used for the names of the VMs.



Map<String,BulkInsertInstanceResourcePerInstanceProperties>
getPerInstanceProperties()
Per-instance properties to be set on individual instances.



String
getSourceInstanceTemplate()
Specifies the instance template from which to create instances.



BulkInsertInstanceResource
set(String fieldName,
   Object value) 


BulkInsertInstanceResource
setCount(Long count)
The maximum number of instances to create.



BulkInsertInstanceResource
setInstanceProperties(InstanceProperties instanceProperties)
The instance properties defining the VM instances to be created.



BulkInsertInstanceResource
setLocationPolicy(LocationPolicy locationPolicy)
Policy for choosing target zone.



BulkInsertInstanceResource
setMinCount(Long minCount)
The minimum number of instances to create.



BulkInsertInstanceResource
setNamePattern(String namePattern)
The string pattern used for the names of the VMs.



BulkInsertInstanceResource
setPerInstanceProperties(Map<String,BulkInsertInstanceResourcePerInstanceProperties> perInstanceProperties)
Per-instance properties to be set on individual instances.



BulkInsertInstanceResource
setSourceInstanceTemplate(String sourceInstanceTemplate)
Specifies the instance template from which to create instances.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





BulkInsertInstanceResource
public BulkInsertInstanceResource()









Method Detail





getCount
public Long getCount()
The maximum number of instances to create.

Returns:
value or null for none








setCount
public BulkInsertInstanceResource setCount(Long count)
The maximum number of instances to create.

Parameters:
count - count or null for none








getInstanceProperties
public InstanceProperties getInstanceProperties()
The instance properties defining the VM instances to be created. Required if
 sourceInstanceTemplate is not provided.

Returns:
value or null for none








setInstanceProperties
public BulkInsertInstanceResource setInstanceProperties(InstanceProperties instanceProperties)
The instance properties defining the VM instances to be created. Required if
 sourceInstanceTemplate is not provided.

Parameters:
instanceProperties - instanceProperties or null for none








getLocationPolicy
public LocationPolicy getLocationPolicy()
Policy for choosing target zone. For more information, see Create VMs in bulk.

Returns:
value or null for none








setLocationPolicy
public BulkInsertInstanceResource setLocationPolicy(LocationPolicy locationPolicy)
Policy for choosing target zone. For more information, see Create VMs in bulk.

Parameters:
locationPolicy - locationPolicy or null for none








getMinCount
public Long getMinCount()
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:
value or null for none








setMinCount
public BulkInsertInstanceResource setMinCount(Long minCount)
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.

Parameters:
minCount - minCount or null for none








getNamePattern
public String 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:
value or null for none








setNamePattern
public BulkInsertInstanceResource setNamePattern(String namePattern)
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.

Parameters:
namePattern - namePattern or null for none








getPerInstanceProperties
public Map<String,BulkInsertInstanceResourcePerInstanceProperties> 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.

Returns:
value or null for none








setPerInstanceProperties
public BulkInsertInstanceResource setPerInstanceProperties(Map<String,BulkInsertInstanceResourcePerInstanceProperties> 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.

Parameters:
perInstanceProperties - perInstanceProperties or null for none








getSourceInstanceTemplate
public String getSourceInstanceTemplate()
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:
value or null for none








setSourceInstanceTemplate
public BulkInsertInstanceResource setSourceInstanceTemplate(String sourceInstanceTemplate)
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.

Parameters:
sourceInstanceTemplate - sourceInstanceTemplate or null for none








set
public BulkInsertInstanceResource set(String fieldName,
                                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public BulkInsertInstanceResource clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`BulkInsertInstanceResource`	`clone()`
`Long`	`getCount()` The maximum number of instances to create.
`InstanceProperties`	`getInstanceProperties()` The instance properties defining the VM instances to be created.
`LocationPolicy`	`getLocationPolicy()` Policy for choosing target zone.
`Long`	`getMinCount()` The minimum number of instances to create.
`String`	`getNamePattern()` The string pattern used for the names of the VMs.
`Map<String,BulkInsertInstanceResourcePerInstanceProperties>`	`getPerInstanceProperties()` Per-instance properties to be set on individual instances.
`String`	`getSourceInstanceTemplate()` Specifies the instance template from which to create instances.
`BulkInsertInstanceResource`	`set(String fieldName, Object value)`
`BulkInsertInstanceResource`	`setCount(Long count)` The maximum number of instances to create.
`BulkInsertInstanceResource`	`setInstanceProperties(InstanceProperties instanceProperties)` The instance properties defining the VM instances to be created.
`BulkInsertInstanceResource`	`setLocationPolicy(LocationPolicy locationPolicy)` Policy for choosing target zone.
`BulkInsertInstanceResource`	`setMinCount(Long minCount)` The minimum number of instances to create.
`BulkInsertInstanceResource`	`setNamePattern(String namePattern)` The string pattern used for the names of the VMs.
`BulkInsertInstanceResource`	`setPerInstanceProperties(Map<String,BulkInsertInstanceResourcePerInstanceProperties> perInstanceProperties)` Per-instance properties to be set on individual instances.
`BulkInsertInstanceResource`	`setSourceInstanceTemplate(String sourceInstanceTemplate)` Specifies the instance template from which to create instances.