Interface BulkInsertInstanceResourceOrBuilder (1.54.0)

Version 1.54.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface BulkInsertInstanceResourceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsPerInstanceProperties(String key)

public abstract boolean containsPerInstanceProperties(String key)

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.

map<string, .google.cloud.compute.v1.BulkInsertInstanceResourcePerInstanceProperties> per_instance_properties = 108502267;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCount()

public abstract long getCount()

The maximum number of instances to create.

optional int64 count = 94851343;

Returns
Type	Description
long	The count.

getInstanceProperties()

public abstract InstanceProperties getInstanceProperties()

The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

Returns
Type	Description
InstanceProperties	The instanceProperties.

getInstancePropertiesOrBuilder()

public abstract InstancePropertiesOrBuilder getInstancePropertiesOrBuilder()

The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

Returns
Type	Description
InstancePropertiesOrBuilder

getLocationPolicy()

public abstract LocationPolicy getLocationPolicy()

Policy for chosing target zone. For more information, see Create VMs in bulk .

optional .google.cloud.compute.v1.LocationPolicy location_policy = 465689852;

Returns
Type	Description
LocationPolicy	The locationPolicy.

getLocationPolicyOrBuilder()

public abstract LocationPolicyOrBuilder getLocationPolicyOrBuilder()

Policy for chosing target zone. For more information, see Create VMs in bulk .

optional .google.cloud.compute.v1.LocationPolicy location_policy = 465689852;

Returns
Type	Description
LocationPolicyOrBuilder

getMinCount()

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

optional int64 min_count = 523228386;

Returns
Type	Description
long	The minCount.

getNamePattern()

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

optional string name_pattern = 413815260;

Returns
Type	Description
String	The namePattern.

getNamePatternBytes()

public abstract ByteString getNamePatternBytes()

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.

optional string name_pattern = 413815260;

Returns
Type	Description
ByteString	The bytes for namePattern.

getPerInstanceProperties() (deprecated)

public abstract Map<String,BulkInsertInstanceResourcePerInstanceProperties> getPerInstanceProperties()

Use #getPerInstancePropertiesMap() instead.

Returns
Type	Description
Map<String,BulkInsertInstanceResourcePerInstanceProperties>

getPerInstancePropertiesCount()

public abstract int getPerInstancePropertiesCount()

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.

map<string, .google.cloud.compute.v1.BulkInsertInstanceResourcePerInstanceProperties> per_instance_properties = 108502267;

Returns
Type	Description
int

getPerInstancePropertiesMap()

public abstract Map<String,BulkInsertInstanceResourcePerInstanceProperties> getPerInstancePropertiesMap()

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.

map<string, .google.cloud.compute.v1.BulkInsertInstanceResourcePerInstanceProperties> per_instance_properties = 108502267;

Returns
Type	Description
Map<String,BulkInsertInstanceResourcePerInstanceProperties>

getPerInstancePropertiesOrDefault(String key, BulkInsertInstanceResourcePerInstanceProperties defaultValue)

public abstract BulkInsertInstanceResourcePerInstanceProperties getPerInstancePropertiesOrDefault(String key, BulkInsertInstanceResourcePerInstanceProperties defaultValue)

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.

map<string, .google.cloud.compute.v1.BulkInsertInstanceResourcePerInstanceProperties> per_instance_properties = 108502267;

Parameters
Name	Description
key	String
defaultValue	BulkInsertInstanceResourcePerInstanceProperties

Returns
Type	Description
BulkInsertInstanceResourcePerInstanceProperties

getPerInstancePropertiesOrThrow(String key)

public abstract BulkInsertInstanceResourcePerInstanceProperties getPerInstancePropertiesOrThrow(String key)

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.

map<string, .google.cloud.compute.v1.BulkInsertInstanceResourcePerInstanceProperties> per_instance_properties = 108502267;

Parameter
Name	Description
key	String

Returns
Type	Description
BulkInsertInstanceResourcePerInstanceProperties

getSourceInstanceTemplate()

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

optional string source_instance_template = 332423616;

Returns
Type	Description
String	The sourceInstanceTemplate.

getSourceInstanceTemplateBytes()

public abstract ByteString getSourceInstanceTemplateBytes()

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.

optional string source_instance_template = 332423616;

Returns
Type	Description
ByteString	The bytes for sourceInstanceTemplate.

hasCount()

public abstract boolean hasCount()

The maximum number of instances to create.

optional int64 count = 94851343;

Returns
Type	Description
boolean	Whether the count field is set.

hasInstanceProperties()

public abstract boolean hasInstanceProperties()

The instance properties defining the VM instances to be created. Required if sourceInstanceTemplate is not provided.

optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

Returns
Type	Description
boolean	Whether the instanceProperties field is set.

hasLocationPolicy()

public abstract boolean hasLocationPolicy()

Policy for chosing target zone. For more information, see Create VMs in bulk .

optional .google.cloud.compute.v1.LocationPolicy location_policy = 465689852;

Returns
Type	Description
boolean	Whether the locationPolicy field is set.

hasMinCount()

public abstract boolean hasMinCount()

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.

optional int64 min_count = 523228386;

Returns
Type	Description
boolean	Whether the minCount field is set.

hasNamePattern()

public abstract boolean hasNamePattern()

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.

optional string name_pattern = 413815260;

Returns
Type	Description
boolean	Whether the namePattern field is set.

hasSourceInstanceTemplate()

public abstract boolean hasSourceInstanceTemplate()

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.

optional string source_instance_template = 332423616;

Returns
Type	Description
boolean	Whether the sourceInstanceTemplate field is set.