Compute V1 Client - Class DetachDiskInstanceRequest (1.14.0)

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

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

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ device_name string

The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.

↳ instance string

Instance name for this request.

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

getDeviceName

The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.

Returns
TypeDescription
string

setDeviceName

The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstance

Instance name for this request.

Returns
TypeDescription
string

setInstance

Instance name for this request.

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

Instance name for this request.

deviceName string

The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.

Returns
TypeDescription
Google\Cloud\Compute\V1\DetachDiskInstanceRequest