Compute V1 Client - Class UpdateInstanceRequest (1.18.0)

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

A request message for Instances.Update. See the method description for details.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instance string

Name of the instance resource to update.

↳ instance_resource Google\Cloud\Compute\V1\Instance

The body resource for this request

↳ minimal_action string

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Check the MinimalAction enum for the list of possible values.

↳ most_disruptive_allowed_action string

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Check the MostDisruptiveAllowedAction enum for the list of possible values.

↳ project string

Project ID for this request.

↳ request_id string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

↳ zone string

The name of the zone for this request.

getInstance

Name of the instance resource to update.

Returns
Type Description
string

setInstance

Name of the instance resource to update.

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceResource

The body resource for this request

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

hasInstanceResource

clearInstanceResource

setInstanceResource

The body resource for this request

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

getMinimalAction

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.

Check the MinimalAction enum for the list of possible values.

Returns
Type Description
string

hasMinimalAction

clearMinimalAction

setMinimalAction

Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.

Check the MinimalAction enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getMostDisruptiveAllowedAction

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.

Check the MostDisruptiveAllowedAction enum for the list of possible values.

Returns
Type Description
string

hasMostDisruptiveAllowedAction

clearMostDisruptiveAllowedAction

setMostDisruptiveAllowedAction

Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.

Check the MostDisruptiveAllowedAction enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getProject

Project ID for this request.

Returns
Type Description
string

setProject

Project ID for this request.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

hasRequestId

clearRequestId

setRequestId

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

getZone

The name of the zone for this request.

Returns
Type Description
string

setZone

The name of the zone for this request.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
project string

Project ID for this request.

zone string

The name of the zone for this request.

instance string

Name of the instance resource to update.

instanceResource Google\Cloud\Compute\V1\Instance

The body resource for this request

Returns
Type Description
Google\Cloud\Compute\V1\UpdateInstanceRequest