Compute V1 Client - Class InstanceTemplate (1.5.0)

Reference documentation and code samples for the Compute V1 Client class InstanceTemplate.

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

Generated from protobuf message google.cloud.compute.v1.InstanceTemplate

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ creation_timestamp string

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

↳ description string

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

↳ id int|string

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

↳ kind string

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

↳ name string

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]([-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.

↳ properties Google\Cloud\Compute\V1\InstanceProperties

The instance properties for this instance template.

↳ self_link string

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

↳ source_instance string

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

↳ source_instance_params Google\Cloud\Compute\V1\SourceInstanceParams

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

getCreationTimestamp

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

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

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

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

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

Generated from protobuf field optional string description = 422937596;

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

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

Generated from protobuf field optional string description = 422937596;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

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

Generated from protobuf field optional uint64 id = 3355;

Returns
TypeDescription
int|string

hasId

clearId

setId

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

Generated from protobuf field optional uint64 id = 3355;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getKind

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

Generated from protobuf field optional string kind = 3292052;

Returns
TypeDescription
string

hasKind

clearKind

setKind

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

Generated from protobuf field optional string kind = 3292052;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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]([-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.

Generated from protobuf field optional string name = 3373707;

Returns
TypeDescription
string

hasName

clearName

setName

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]([-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.

Generated from protobuf field optional string name = 3373707;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProperties

The instance properties for this instance template.

Generated from protobuf field optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Returns
TypeDescription
Google\Cloud\Compute\V1\InstanceProperties|null

hasProperties

clearProperties

setProperties

The instance properties for this instance template.

Generated from protobuf field optional .google.cloud.compute.v1.InstanceProperties properties = 147688755;

Parameter
NameDescription
var Google\Cloud\Compute\V1\InstanceProperties
Returns
TypeDescription
$this

getSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Returns
TypeDescription
string

hasSelfLink

clearSelfLink

setSelfLink

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

Generated from protobuf field optional string self_link = 456214797;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

Generated from protobuf field optional string source_instance = 396315705;

Returns
TypeDescription
string

hasSourceInstance

clearSourceInstance

setSourceInstance

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

Generated from protobuf field optional string source_instance = 396315705;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceInstanceParams

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

Generated from protobuf field optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Returns
TypeDescription
Google\Cloud\Compute\V1\SourceInstanceParams|null

hasSourceInstanceParams

clearSourceInstanceParams

setSourceInstanceParams

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

Generated from protobuf field optional .google.cloud.compute.v1.SourceInstanceParams source_instance_params = 135342156;

Parameter
NameDescription
var Google\Cloud\Compute\V1\SourceInstanceParams
Returns
TypeDescription
$this