Class InstanceTemplate.Builder (1.54.0)

public static final class InstanceTemplate.Builder extends GeneratedMessageV3.Builder<InstanceTemplate.Builder> implements InstanceTemplateOrBuilder

Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * Global * Regional You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.

Protobuf type google.cloud.compute.v1.InstanceTemplate

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstanceTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstanceTemplate.Builder
Overrides

build()

public InstanceTemplate build()
Returns
Type Description
InstanceTemplate

buildPartial()

public InstanceTemplate buildPartial()
Returns
Type Description
InstanceTemplate

clear()

public InstanceTemplate.Builder clear()
Returns
Type Description
InstanceTemplate.Builder
Overrides

clearCreationTimestamp()

public InstanceTemplate.Builder clearCreationTimestamp()

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearDescription()

public InstanceTemplate.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InstanceTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
InstanceTemplate.Builder
Overrides

clearId()

public InstanceTemplate.Builder clearId()

[Output Only] A unique identifier for this instance template. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearKind()

public InstanceTemplate.Builder clearKind()

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

optional string kind = 3292052;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearName()

public InstanceTemplate.Builder clearName()

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
InstanceTemplate.Builder
Overrides

clearProperties()

public InstanceTemplate.Builder clearProperties()

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Returns
Type Description
InstanceTemplate.Builder

clearRegion()

public InstanceTemplate.Builder clearRegion()

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

optional string region = 138946292;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

public InstanceTemplate.Builder clearSelfLink()

[Output Only] The URL for this instance template. The server defines this URL.

optional string self_link = 456214797;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearSourceInstance()

public InstanceTemplate.Builder clearSourceInstance()

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

clearSourceInstanceParams()

public InstanceTemplate.Builder clearSourceInstanceParams()

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Returns
Type Description
InstanceTemplate.Builder

clone()

public InstanceTemplate.Builder clone()
Returns
Type Description
InstanceTemplate.Builder
Overrides

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public InstanceTemplate getDefaultInstanceForType()
Returns
Type Description
InstanceTemplate

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getId()

public long getId()

[Output Only] A unique identifier for this instance template. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getProperties()

public InstanceProperties getProperties()

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Returns
Type Description
InstanceProperties

The properties.

getPropertiesBuilder()

public InstanceProperties.Builder getPropertiesBuilder()

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Returns
Type Description
InstanceProperties.Builder

getPropertiesOrBuilder()

public InstancePropertiesOrBuilder getPropertiesOrBuilder()

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Returns
Type Description
InstancePropertiesOrBuilder

getRegion()

public String getRegion()

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

public String getSelfLink()

[Output Only] The URL for this instance template. The server defines this URL.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] The URL for this instance template. The server defines this URL.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSourceInstance()

public String getSourceInstance()

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type Description
String

The sourceInstance.

getSourceInstanceBytes()

public ByteString getSourceInstanceBytes()

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type Description
ByteString

The bytes for sourceInstance.

getSourceInstanceParams()

public SourceInstanceParams getSourceInstanceParams()

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Returns
Type Description
SourceInstanceParams

The sourceInstanceParams.

getSourceInstanceParamsBuilder()

public SourceInstanceParams.Builder getSourceInstanceParamsBuilder()

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Returns
Type Description
SourceInstanceParams.Builder

getSourceInstanceParamsOrBuilder()

public SourceInstanceParamsOrBuilder getSourceInstanceParamsOrBuilder()

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Returns
Type Description
SourceInstanceParamsOrBuilder

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

[Output Only] A unique identifier for this instance template. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasProperties()

public boolean hasProperties()

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Returns
Type Description
boolean

Whether the properties field is set.

hasRegion()

public boolean hasRegion()

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

public boolean hasSelfLink()

[Output Only] The URL for this instance template. The server defines this URL.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSourceInstance()

public boolean hasSourceInstance()

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type Description
boolean

Whether the sourceInstance field is set.

hasSourceInstanceParams()

public boolean hasSourceInstanceParams()

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Returns
Type Description
boolean

Whether the sourceInstanceParams field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(InstanceTemplate other)

public InstanceTemplate.Builder mergeFrom(InstanceTemplate other)
Parameter
Name Description
other InstanceTemplate
Returns
Type Description
InstanceTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InstanceTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InstanceTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public InstanceTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
InstanceTemplate.Builder
Overrides

mergeProperties(InstanceProperties value)

public InstanceTemplate.Builder mergeProperties(InstanceProperties value)

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Parameter
Name Description
value InstanceProperties
Returns
Type Description
InstanceTemplate.Builder

mergeSourceInstanceParams(SourceInstanceParams value)

public InstanceTemplate.Builder mergeSourceInstanceParams(SourceInstanceParams value)

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Parameter
Name Description
value SourceInstanceParams
Returns
Type Description
InstanceTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InstanceTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InstanceTemplate.Builder
Overrides

setCreationTimestamp(String value)

public InstanceTemplate.Builder setCreationTimestamp(String value)

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public InstanceTemplate.Builder setCreationTimestampBytes(ByteString value)

[Output Only] The creation timestamp for this instance template in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setDescription(String value)

public InstanceTemplate.Builder setDescription(String value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public InstanceTemplate.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InstanceTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstanceTemplate.Builder
Overrides

setId(long value)

public InstanceTemplate.Builder setId(long value)

[Output Only] A unique identifier for this instance template. The server defines this identifier.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setKind(String value)

public InstanceTemplate.Builder setKind(String value)

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setKindBytes(ByteString value)

public InstanceTemplate.Builder setKindBytes(ByteString value)

[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setName(String value)

public InstanceTemplate.Builder setName(String value)

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public InstanceTemplate.Builder setNameBytes(ByteString value)

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setProperties(InstanceProperties value)

public InstanceTemplate.Builder setProperties(InstanceProperties value)

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Parameter
Name Description
value InstanceProperties
Returns
Type Description
InstanceTemplate.Builder

setProperties(InstanceProperties.Builder builderForValue)

public InstanceTemplate.Builder setProperties(InstanceProperties.Builder builderForValue)

The instance properties for this instance template.

optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Parameter
Name Description
builderForValue InstanceProperties.Builder
Returns
Type Description
InstanceTemplate.Builder

setRegion(String value)

public InstanceTemplate.Builder setRegion(String value)

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

optional string region = 138946292;

Parameter
Name Description
value String

The region to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public InstanceTemplate.Builder setRegionBytes(ByteString value)

[Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

optional string region = 138946292;

Parameter
Name Description
value ByteString

The bytes for region to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public InstanceTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
InstanceTemplate.Builder
Overrides
public InstanceTemplate.Builder setSelfLink(String value)

[Output Only] The URL for this instance template. The server defines this URL.

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public InstanceTemplate.Builder setSelfLinkBytes(ByteString value)

[Output Only] The URL for this instance template. The server defines this URL.

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setSourceInstance(String value)

public InstanceTemplate.Builder setSourceInstance(String value)

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Parameter
Name Description
value String

The sourceInstance to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setSourceInstanceBytes(ByteString value)

public InstanceTemplate.Builder setSourceInstanceBytes(ByteString value)

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Parameter
Name Description
value ByteString

The bytes for sourceInstance to set.

Returns
Type Description
InstanceTemplate.Builder

This builder for chaining.

setSourceInstanceParams(SourceInstanceParams value)

public InstanceTemplate.Builder setSourceInstanceParams(SourceInstanceParams value)

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Parameter
Name Description
value SourceInstanceParams
Returns
Type Description
InstanceTemplate.Builder

setSourceInstanceParams(SourceInstanceParams.Builder builderForValue)

public InstanceTemplate.Builder setSourceInstanceParams(SourceInstanceParams.Builder builderForValue)

The source instance params to use to create this instance template.

optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Parameter
Name Description
builderForValue SourceInstanceParams.Builder
Returns
Type Description
InstanceTemplate.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final InstanceTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
InstanceTemplate.Builder
Overrides