Compute V1 Client - Class SuspendInstanceRequest (1.13.0)

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

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

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ discard_local_ssd bool

If true, discard the contents of any attached localSSD partitions. Default value is false.

↳ instance string

Name of the instance resource to suspend.

↳ 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.

getDiscardLocalSsd

If true, discard the contents of any attached localSSD partitions. Default value is false.

Returns
TypeDescription
bool

hasDiscardLocalSsd

clearDiscardLocalSsd

setDiscardLocalSsd

If true, discard the contents of any attached localSSD partitions. Default value is false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getInstance

Name of the instance resource to suspend.

Returns
TypeDescription
string

setInstance

Name of the instance resource to suspend.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProject

Project ID for this request.

Returns
TypeDescription
string

setProject

Project ID for this request.

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getZone

The name of the zone for this request.

Returns
TypeDescription
string

setZone

The name of the zone for this request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

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

Returns
TypeDescription
Google\Cloud\Compute\V1\SuspendInstanceRequest