Reference documentation and code samples for the Compute V1 Client class CreateSnapshotDiskRequest.
A request message for Disks.CreateSnapshot. See the method description for details.
Generated from protobuf message google.cloud.compute.v1.CreateSnapshotDiskRequest
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ disk |
string
Name of the persistent disk to snapshot. |
↳ guest_flush |
bool
[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. |
↳ 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). |
↳ snapshot_resource |
Google\Cloud\Compute\V1\Snapshot
The body resource for this request |
↳ zone |
string
The name of the zone for this request. |
getDisk
Name of the persistent disk to snapshot.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisk
Name of the persistent disk to snapshot.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGuestFlush
[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasGuestFlush
clearGuestFlush
setGuestFlush
[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| 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 | |
getSnapshotResource
The body resource for this request
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Snapshot|null | |
hasSnapshotResource
clearSnapshotResource
setSnapshotResource
The body resource for this request
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\Snapshot
|
| 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. |
disk |
string
Name of the persistent disk to snapshot. |
snapshotResource |
Google\Cloud\Compute\V1\Snapshot
The body resource for this request |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\CreateSnapshotDiskRequest | |