Compute V1 Client - Class InstanceGroupManagersApplyUpdatesRequest (1.8.3)

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

InstanceGroupManagers.applyUpdatesToInstances

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ all_instances bool

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

↳ instances array

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

↳ minimal_action string

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. Check the MinimalAction enum for the list of possible values.

↳ most_disruptive_allowed_action string

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. Check the MostDisruptiveAllowedAction enum for the list of possible values.

getAllInstances

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

Returns
TypeDescription
bool

hasAllInstances

clearAllInstances

setAllInstances

Flag to update all instances instead of specified list of “instances”. If the flag is set to true then the instances may not be specified in the request.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getInstances

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInstances

The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getMinimalAction

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.

Check the MinimalAction enum for the list of possible values.

Returns
TypeDescription
string

hasMinimalAction

clearMinimalAction

setMinimalAction

The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.

Check the MinimalAction enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMostDisruptiveAllowedAction

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.

Check the MostDisruptiveAllowedAction enum for the list of possible values.

Returns
TypeDescription
string

hasMostDisruptiveAllowedAction

clearMostDisruptiveAllowedAction

setMostDisruptiveAllowedAction

The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.

Check the MostDisruptiveAllowedAction enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this