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
Methods
__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.
Generated from protobuf field string disk = 3083677 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisk
Name of the persistent disk to snapshot.
Generated from protobuf field string disk = 3083677 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field optional bool guest_flush = 385550813;
| 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.
Generated from protobuf field optional bool guest_flush = 385550813;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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).
Generated from protobuf field optional string request_id = 37109963;
| 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).
Generated from protobuf field optional string request_id = 37109963;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSnapshotResource
The body resource for this request
Generated from protobuf field .google.cloud.compute.v1.Snapshot snapshot_resource = 481319977 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Snapshot|null | |
hasSnapshotResource
clearSnapshotResource
setSnapshotResource
The body resource for this request
Generated from protobuf field .google.cloud.compute.v1.Snapshot snapshot_resource = 481319977 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\Snapshot
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |