Class BulkInsertInstanceResource (1.54.0)

public final class BulkInsertInstanceResource extends GeneratedMessageV3 implements BulkInsertInstanceResourceOrBuilder

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.

Protobuf type google.cloud.compute.v1.BulkInsertInstanceResource

Static Fields

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_PROPERTIES_FIELD_NUMBER

public static final int INSTANCE_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_POLICY_FIELD_NUMBER

public static final int LOCATION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

MIN_COUNT_FIELD_NUMBER

public static final int MIN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

NAME_PATTERN_FIELD_NUMBER

public static final int NAME_PATTERN_FIELD_NUMBER
Field Value
Type Description
int

PER_INSTANCE_PROPERTIES_FIELD_NUMBER

public static final int PER_INSTANCE_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_INSTANCE_TEMPLATE_FIELD_NUMBER

public static final int SOURCE_INSTANCE_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BulkInsertInstanceResource getDefaultInstance()
Returns
Type Description
BulkInsertInstanceResource

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BulkInsertInstanceResource.Builder newBuilder()
Returns
Type Description
BulkInsertInstanceResource.Builder

newBuilder(BulkInsertInstanceResource prototype)

public static BulkInsertInstanceResource.Builder newBuilder(BulkInsertInstanceResource prototype)
Parameter
Name Description
prototype BulkInsertInstanceResource
Returns
Type Description
BulkInsertInstanceResource.Builder

parseDelimitedFrom(InputStream input)

public static BulkInsertInstanceResource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BulkInsertInstanceResource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BulkInsertInstanceResource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BulkInsertInstanceResource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BulkInsertInstanceResource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BulkInsertInstanceResource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BulkInsertInstanceResource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BulkInsertInstanceResource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BulkInsertInstanceResource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BulkInsertInstanceResource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BulkInsertInstanceResource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BulkInsertInstanceResource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BulkInsertInstanceResource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BulkInsertInstanceResource> parser()
Returns
Type Description
Parser<BulkInsertInstanceResource>

Methods

containsPerInstanceProperties(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCount()

public long getCount()

The maximum number of instances to create.

optional int64 count = 94851343;

Returns
Type Description
long

The count.

getDefaultInstanceForType()

public BulkInsertInstanceResource getDefaultInstanceForType()
Returns
Type Description
BulkInsertInstanceResource

getInstanceProperties()

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

getParserForType()

public Parser<BulkInsertInstanceResource> getParserForType()
Returns
Type Description
Parser<BulkInsertInstanceResource>
Overrides

getPerInstanceProperties() (deprecated)

public Map<String,BulkInsertInstanceResourcePerInstanceProperties> getPerInstanceProperties()
Returns
Type Description
Map<String,BulkInsertInstanceResourcePerInstanceProperties>

getPerInstancePropertiesCount()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

optional string source_instance_template = 332423616;

Returns
Type Description
String

The sourceInstanceTemplate.

getSourceInstanceTemplateBytes()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BulkInsertInstanceResource.Builder newBuilderForType()
Returns
Type Description
BulkInsertInstanceResource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BulkInsertInstanceResource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BulkInsertInstanceResource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BulkInsertInstanceResource.Builder toBuilder()
Returns
Type Description
BulkInsertInstanceResource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException