Class InstanceTemplate.Builder (1.29.0)

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

Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.

Protobuf type google.cloud.compute.v1.InstanceTemplate

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstanceTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
InstanceTemplate.Builder
Overrides

build()

public InstanceTemplate build()
Returns
TypeDescription
InstanceTemplate

buildPartial()

public InstanceTemplate buildPartial()
Returns
TypeDescription
InstanceTemplate

clear()

public InstanceTemplate.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
InstanceTemplate.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public InstanceTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
InstanceTemplate.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
InstanceTemplate.Builder
Overrides

clearProperties()

public InstanceTemplate.Builder clearProperties()

The instance properties for this instance template.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
InstanceTemplate.Builder

clone()

public InstanceTemplate.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public InstanceTemplate getDefaultInstanceForType()
Returns
TypeDescription
InstanceTemplate

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
InstanceProperties

The properties.

getPropertiesBuilder()

public InstanceProperties.Builder getPropertiesBuilder()

The instance properties for this instance template.

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

Returns
TypeDescription
InstanceProperties.Builder

getPropertiesOrBuilder()

public InstancePropertiesOrBuilder getPropertiesOrBuilder()

The instance properties for this instance template.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
SourceInstanceParamsOrBuilder

hasCreationTimestamp()

public boolean hasCreationTimestamp()

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

optional string creation_timestamp = 30525366;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the sourceInstanceParams field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(InstanceTemplate other)

public InstanceTemplate.Builder mergeFrom(InstanceTemplate other)
Parameter
NameDescription
otherInstanceTemplate
Returns
TypeDescription
InstanceTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public InstanceTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public InstanceTemplate.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueInstanceProperties
Returns
TypeDescription
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
NameDescription
valueSourceInstanceParams
Returns
TypeDescription
InstanceTemplate.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final InstanceTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
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
NameDescription
valueString

The description to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
InstanceTemplate.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public InstanceTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The id to set.

Returns
TypeDescription
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
NameDescription
valueString

The kind to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
valueInstanceProperties
Returns
TypeDescription
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
NameDescription
builderForValueInstanceProperties.Builder
Returns
TypeDescription
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
NameDescription
valueString

The region to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
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
NameDescription
valueString

The sourceInstance to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for sourceInstance to set.

Returns
TypeDescription
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
NameDescription
valueSourceInstanceParams
Returns
TypeDescription
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
NameDescription
builderForValueSourceInstanceParams.Builder
Returns
TypeDescription
InstanceTemplate.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final InstanceTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
InstanceTemplate.Builder
Overrides