Compute V1 Client - Class UpdateInstanceRequest (1.5.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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Generated from protobuf field string instance = 18257045 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setInstance

Name of the instance resource to update.

Generated from protobuf field string instance = 18257045 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstanceResource

The body resource for this request

Generated from protobuf field .google.cloud.compute.v1.Instance instance_resource = 215988344 [(.google.api.field_behavior) = REQUIRED];

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

hasInstanceResource

clearInstanceResource

setInstanceResource

The body resource for this request

Generated from protobuf field .google.cloud.compute.v1.Instance instance_resource = 215988344 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Compute\V1\Instance
Returns
TypeDescription
$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.

Generated from protobuf field optional string minimal_action = 270567060;

Returns
TypeDescription
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.

Generated from protobuf field optional string minimal_action = 270567060;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field optional string most_disruptive_allowed_action = 66103053;

Returns
TypeDescription
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.

Generated from protobuf field optional string most_disruptive_allowed_action = 66103053;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProject

Project ID for this request.

Generated from protobuf field string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];

Returns
TypeDescription
string

setProject

Project ID for this request.

Generated from protobuf field string project = 227560217 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "project"];

Parameter
NameDescription
var string
Returns
TypeDescription
$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).

Generated from protobuf field optional string request_id = 37109963;

Returns
TypeDescription
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).

Generated from protobuf field optional string request_id = 37109963;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getZone

The name of the zone for this request.

Generated from protobuf field string zone = 3744684 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "zone"];

Returns
TypeDescription
string

setZone

The name of the zone for this request.

Generated from protobuf field string zone = 3744684 [(.google.api.field_behavior) = REQUIRED, (.google.cloud.operation_request_field) = "zone"];

Parameter
NameDescription
var string
Returns
TypeDescription
$this