Package com.google.cloud.compute.v1

Class InstanceTemplate

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.InstanceTemplate
All Implemented Interfaces:
InstanceTemplateOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class InstanceTemplate extends com.google.protobuf.GeneratedMessage implements InstanceTemplateOrBuilder
 Represents an Instance Template resource.

 Google Compute Engine has two Instance Template resources:

 * [Global](/compute/docs/reference/rest/v1/instanceTemplates)
 * [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates)

 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, readInstance Templates.
Protobuf type google.cloud.compute.v1.InstanceTemplate
See Also:

  • Field Details

    • CREATION_TIMESTAMP_FIELD_NUMBER

      public static final int CREATION_TIMESTAMP_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • PROPERTIES_FIELD_NUMBER

      public static final int PROPERTIES_FIELD_NUMBER
      See Also:

    • REGION_FIELD_NUMBER

      public static final int REGION_FIELD_NUMBER
      See Also:

    • SOURCE_INSTANCE_FIELD_NUMBER

      public static final int SOURCE_INSTANCE_FIELD_NUMBER
      See Also:

    • SOURCE_INSTANCE_PARAMS_FIELD_NUMBER

      public static final int SOURCE_INSTANCE_PARAMS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasCreationTimestamp

      public boolean hasCreationTimestamp()
       Output only. [Output Only] The creation timestamp for this instance template inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      hasCreationTimestamp in interface InstanceTemplateOrBuilder
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      public String getCreationTimestamp()
       Output only. [Output Only] The creation timestamp for this instance template inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      getCreationTimestamp in interface InstanceTemplateOrBuilder
      Returns:
      The creationTimestamp.

    • getCreationTimestampBytes

      public com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] The creation timestamp for this instance template inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      getCreationTimestampBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for creationTimestamp.

    • hasDescription

      public boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      hasDescription in interface InstanceTemplateOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      getDescription in interface InstanceTemplateOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      getDescriptionBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for description.

    • hasId

      public boolean hasId()
       Output only. [Output Only] A unique identifier for this instance template. The server
 defines this identifier.
      optional uint64 id = 3355;
      Specified by:
      hasId in interface InstanceTemplateOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public long getId()
       Output only. [Output Only] A unique identifier for this instance template. The server
 defines this identifier.
      optional uint64 id = 3355;
      Specified by:
      getId in interface InstanceTemplateOrBuilder
      Returns:
      The id.

    • hasKind

      public boolean hasKind()
       Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
      optional string kind = 3292052;
      Specified by:
      hasKind in interface InstanceTemplateOrBuilder
      Returns:
      Whether the kind field is set.

    • getKind

      public String getKind()
       Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
      optional string kind = 3292052;
      Specified by:
      getKind in interface InstanceTemplateOrBuilder
      Returns:
      The kind.

    • getKindBytes

      public com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.
      optional string kind = 3292052;
      Specified by:
      getKindBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for kind.

    • 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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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;
      Specified by:
      hasName in interface InstanceTemplateOrBuilder
      Returns:
      Whether the name field is set.

    • 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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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;
      Specified by:
      getName in interface InstanceTemplateOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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;
      Specified by:
      getNameBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for name.

    • hasProperties

      public boolean hasProperties()
       The instance properties for this instance template.
      optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;
      Specified by:
      hasProperties in interface InstanceTemplateOrBuilder
      Returns:
      Whether the properties field is set.

    • getProperties

      public InstanceProperties getProperties()
       The instance properties for this instance template.
      optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;
      Specified by:
      getProperties in interface InstanceTemplateOrBuilder
      Returns:
      The properties.

    • getPropertiesOrBuilder

      public InstancePropertiesOrBuilder getPropertiesOrBuilder()
       The instance properties for this instance template.
      optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;
      Specified by:
      getPropertiesOrBuilder in interface InstanceTemplateOrBuilder

    • hasRegion

      public boolean hasRegion()
       Output only. [Output Only] URL of the region where the instance template resides. Only
 applicable for regional resources.
      optional string region = 138946292;
      Specified by:
      hasRegion in interface InstanceTemplateOrBuilder
      Returns:
      Whether the region field is set.

    • getRegion

      public String getRegion()
       Output only. [Output Only] URL of the region where the instance template resides. Only
 applicable for regional resources.
      optional string region = 138946292;
      Specified by:
      getRegion in interface InstanceTemplateOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       Output only. [Output Only] URL of the region where the instance template resides. Only
 applicable for regional resources.
      optional string region = 138946292;
      Specified by:
      getRegionBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for region.

    • hasSelfLink

      public boolean hasSelfLink()
       Output only. [Output Only] The URL for this instance template. The server defines this
 URL.
      optional string self_link = 456214797;
      Specified by:
      hasSelfLink in interface InstanceTemplateOrBuilder
      Returns:
      Whether the selfLink field is set.

    • getSelfLink

      public String getSelfLink()
       Output only. [Output Only] The URL for this instance template. The server defines this
 URL.
      optional string self_link = 456214797;
      Specified by:
      getSelfLink in interface InstanceTemplateOrBuilder
      Returns:
      The selfLink.

    • getSelfLinkBytes

      public com.google.protobuf.ByteString getSelfLinkBytes()
       Output only. [Output Only] The URL for this instance template. The server defines this
 URL.
      optional string self_link = 456214797;
      Specified by:
      getSelfLinkBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for selfLink.

    • 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;
      Specified by:
      hasSourceInstance in interface InstanceTemplateOrBuilder
      Returns:
      Whether the sourceInstance field is set.

    • 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;
      Specified by:
      getSourceInstance in interface InstanceTemplateOrBuilder
      Returns:
      The sourceInstance.

    • getSourceInstanceBytes

      public com.google.protobuf.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;
      Specified by:
      getSourceInstanceBytes in interface InstanceTemplateOrBuilder
      Returns:
      The bytes for sourceInstance.

    • 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;
      Specified by:
      hasSourceInstanceParams in interface InstanceTemplateOrBuilder
      Returns:
      Whether the sourceInstanceParams field is set.

    • 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;
      Specified by:
      getSourceInstanceParams in interface InstanceTemplateOrBuilder
      Returns:
      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;
      Specified by:
      getSourceInstanceParamsOrBuilder in interface InstanceTemplateOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static InstanceTemplate parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceTemplate parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceTemplate parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceTemplate parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceTemplate parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceTemplate parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static InstanceTemplate parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceTemplate parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static InstanceTemplate parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static InstanceTemplate parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceTemplate parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static InstanceTemplate parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public InstanceTemplate.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static InstanceTemplate.Builder newBuilder()

    • newBuilder

      public static InstanceTemplate.Builder newBuilder(InstanceTemplate prototype)

    • toBuilder

      public InstanceTemplate.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected InstanceTemplate.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static InstanceTemplate getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<InstanceTemplate> parser()

    • getParserForType

      public com.google.protobuf.Parser<InstanceTemplate> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public InstanceTemplate getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder