Class InstanceTemplate (1.41.0)

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

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_INSTANCE_FIELD_NUMBER

public static final int SOURCE_INSTANCE_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_INSTANCE_PARAMS_FIELD_NUMBER

public static final int SOURCE_INSTANCE_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InstanceTemplate getDefaultInstance()
Returns
TypeDescription
InstanceTemplate

getDescriptor()

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

newBuilder()

public static InstanceTemplate.Builder newBuilder()
Returns
TypeDescription
InstanceTemplate.Builder

newBuilder(InstanceTemplate prototype)

public static InstanceTemplate.Builder newBuilder(InstanceTemplate prototype)
Parameter
NameDescription
prototypeInstanceTemplate
Returns
TypeDescription
InstanceTemplate.Builder

parseDelimitedFrom(InputStream input)

public static InstanceTemplate parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InstanceTemplate parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstanceTemplate parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstanceTemplate parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InstanceTemplate parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InstanceTemplate parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceTemplate
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InstanceTemplate> parser()
Returns
TypeDescription
Parser<InstanceTemplate>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
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.

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.

getParserForType()

public Parser<InstanceTemplate> getParserForType()
Returns
TypeDescription
Parser<InstanceTemplate>
Overrides

getProperties()

public InstanceProperties getProperties()

The instance properties for this instance template.

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

Returns
TypeDescription
InstanceProperties

The properties.

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InstanceTemplate.Builder newBuilderForType()
Returns
TypeDescription
InstanceTemplate.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InstanceTemplate.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InstanceTemplate.Builder toBuilder()
Returns
TypeDescription
InstanceTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException