Compute V1 Client - Class InstanceGroupManagerVersion (1.20.0)

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

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ instance_template string

The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the targetSize for this version is reached.
↳ name string

Name of the version. Unique among all versions in the scope of this managed instance group.
↳ target_size Google\Cloud\Compute\V1\FixedOrPercent

Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

getInstanceTemplate

The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the targetSize for this version is reached.

Returns
Type Description
string

hasInstanceTemplate

clearInstanceTemplate

setInstanceTemplate

The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the targetSize for this version is reached. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE; in those cases, existing instances are updated until the targetSize for this version is reached.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the version. Unique among all versions in the scope of this managed instance group.

Returns
Type Description
string

hasName

clearName

setName

Name of the version. Unique among all versions in the scope of this managed instance group.

Parameter
Name Description
var string
Returns
Type Description
$this

getTargetSize

Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

Returns
Type Description
Google\Cloud\Compute\V1\FixedOrPercent|null

hasTargetSize

clearTargetSize

setTargetSize

Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information.

Parameter
Name Description
var Google\Cloud\Compute\V1\FixedOrPercent
Returns
Type Description
$this