Google Cloud Backup Dr V1 Client - Class DiskRestoreProperties (0.7.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class DiskRestoreProperties.

DiskRestoreProperties represents the properties of a Disk restore.

Generated from protobuf message google.cloud.backupdr.v1.DiskRestoreProperties

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the disk.

↳ description string

Optional. An optional description of this resource. Provide this property when you create the resource.

↳ size_gb int|string

Required. The size of the disk in GB.

↳ licenses array

Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image

↳ guest_os_feature array<GuestOsFeature>

Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.

↳ disk_encryption_key CustomerEncryptionKey

Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.

↳ physical_block_size_bytes int|string

Optional. Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently, the supported size is 4096.

↳ provisioned_iops int|string

Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.

↳ provisioned_throughput int|string

Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.

↳ enable_confidential_compute bool

Optional. Indicates whether this disk is using confidential compute mode. Encryption with a Cloud KMS key is required to enable this option.

↳ storage_pool string

Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.

↳ access_mode int

Optional. The access mode of the disk.

↳ architecture int

Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.

↳ resource_policy array

Optional. Resource policies applied to this disk.

↳ type string

Required. URL of the disk type resource describing which disk type to use to create the disk.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty.

↳ resource_manager_tags array|Google\Protobuf\Internal\MapField

Optional. Resource manager tags to be bound to the disk.

getName

Required. Name of the disk.

Returns
Type Description
string

hasName

clearName

setName

Required. Name of the disk.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

Optional. An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getSizeGb

Required. The size of the disk in GB.

Returns
Type Description
int|string

hasSizeGb

clearSizeGb

setSizeGb

Required. The size of the disk in GB.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getLicenses

Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setLicenses

Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image

Parameter
Name Description
var string[]
Returns
Type Description
$this

getGuestOsFeature

Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setGuestOsFeature

Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.

Parameter
Name Description
var array<GuestOsFeature>
Returns
Type Description
$this

getDiskEncryptionKey

Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.

Returns
Type Description
CustomerEncryptionKey|null

hasDiskEncryptionKey

clearDiskEncryptionKey

setDiskEncryptionKey

Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.

Parameter
Name Description
var CustomerEncryptionKey
Returns
Type Description
$this

getPhysicalBlockSizeBytes

Optional. Physical block size of the persistent disk, in bytes.

If not present in a request, a default value is used. Currently, the supported size is 4096.

Returns
Type Description
int|string

hasPhysicalBlockSizeBytes

clearPhysicalBlockSizeBytes

setPhysicalBlockSizeBytes

Optional. Physical block size of the persistent disk, in bytes.

If not present in a request, a default value is used. Currently, the supported size is 4096.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getProvisionedIops

Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.

Returns
Type Description
int|string

hasProvisionedIops

clearProvisionedIops

setProvisionedIops

Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getProvisionedThroughput

Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.

Returns
Type Description
int|string

hasProvisionedThroughput

clearProvisionedThroughput

setProvisionedThroughput

Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getEnableConfidentialCompute

Optional. Indicates whether this disk is using confidential compute mode.

Encryption with a Cloud KMS key is required to enable this option.

Returns
Type Description
bool

hasEnableConfidentialCompute

clearEnableConfidentialCompute

setEnableConfidentialCompute

Optional. Indicates whether this disk is using confidential compute mode.

Encryption with a Cloud KMS key is required to enable this option.

Parameter
Name Description
var bool
Returns
Type Description
$this

getStoragePool

Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.

Returns
Type Description
string

hasStoragePool

clearStoragePool

setStoragePool

Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getAccessMode

Optional. The access mode of the disk.

Returns
Type Description
int

hasAccessMode

clearAccessMode

setAccessMode

Optional. The access mode of the disk.

Parameter
Name Description
var int
Returns
Type Description
$this

getArchitecture

Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.

Returns
Type Description
int

hasArchitecture

clearArchitecture

setArchitecture

Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.

Parameter
Name Description
var int
Returns
Type Description
$this

getResourcePolicy

Optional. Resource policies applied to this disk.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResourcePolicy

Optional. Resource policies applied to this disk.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getType

Required. URL of the disk type resource describing which disk type to use to create the disk.

Returns
Type Description
string

hasType

clearType

setType

Required. URL of the disk type resource describing which disk type to use to create the disk.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels to apply to this disk. These can be modified later using setLabels method. Label values can be empty.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getResourceManagerTags

Optional. Resource manager tags to be bound to the disk.

Returns
Type Description
Google\Protobuf\Internal\MapField

setResourceManagerTags

Optional. Resource manager tags to be bound to the disk.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this