Class InstanceTemplate (1.53.0)

public final class InstanceTemplate extends GeneratedMessageV3 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 Fields

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_INSTANCE_FIELD_NUMBER

public static final int SOURCE_INSTANCE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_INSTANCE_PARAMS_FIELD_NUMBER

public static final int SOURCE_INSTANCE_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static InstanceTemplate getDefaultInstance()
Returns
Type Description
InstanceTemplate

getDescriptor()

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

newBuilder()

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

newBuilder(InstanceTemplate prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

getParserForType()

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

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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