Google Cloud Backup Dr V1 Client - Class ComputeInstanceRestoreProperties (0.5.1)

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

ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore.

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

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 compute instance.

↳ advanced_machine_features
AdvancedMachineFeatures

Optional. Controls for advanced machine-related behavior features.

↳ can_ip_forward
bool

Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.

↳ confidential_instance_config
ConfidentialInstanceConfig

Optional. Controls Confidential compute options on the instance

↳ deletion_protection
bool

Optional. Whether the resource should be protected against deletion.

↳ description
string

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

↳ disks
array< AttachedDisk >

Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them.

↳ display_device
DisplayDevice

Optional. Enables display device for the instance.

↳ guest_accelerators
array< AcceleratorConfig >

Optional. A list of the type and count of accelerator cards attached to the instance.

↳ hostname
string

Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

↳ instance_encryption_key
CustomerEncryptionKey

Optional. Encrypts suspended data for an instance with a customer-managed encryption key.

↳ key_revocation_action_type
int

Optional. KeyRevocationActionType of the instance.

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. Labels to apply to this instance.

↳ machine_type
string

Optional. Full or partial URL of the machine type resource to use for this instance.

↳ metadata
Metadata

Optional. This includes custom metadata and predefined keys.

↳ min_cpu_platform
string

Optional. Minimum CPU platform to use for this instance.

↳ network_interfaces
array< NetworkInterface >

Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

↳ network_performance_config
NetworkPerformanceConfig

Optional. Configure network performance such as egress bandwidth tier.

↳ params
InstanceParams

Input only. Additional params passed with the request, but not persisted as part of resource payload.

↳ private_ipv6_google_access
int

Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.

↳ allocation_affinity
AllocationAffinity

Optional. Specifies the reservations that this instance can consume from.

↳ resource_policies
array

Optional. Resource policies applied to this instance.

↳ scheduling
Scheduling

Optional. Sets the scheduling options for this instance.

↳ service_accounts
array< ServiceAccount >

Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

↳ tags
Tags

Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation.

getName

Required. Name of the compute instance.

Returns
Type
Description
string

hasName

clearName

setName

Required. Name of the compute instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAdvancedMachineFeatures

Optional. Controls for advanced machine-related behavior features.

Returns
Type
Description

hasAdvancedMachineFeatures

clearAdvancedMachineFeatures

setAdvancedMachineFeatures

Optional. Controls for advanced machine-related behavior features.

Parameter
Name
Description
Returns
Type
Description
$this

getCanIpForward

Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.

Returns
Type
Description
bool

hasCanIpForward

clearCanIpForward

setCanIpForward

Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getConfidentialInstanceConfig

Optional. Controls Confidential compute options on the instance

Returns
Type
Description

hasConfidentialInstanceConfig

clearConfidentialInstanceConfig

setConfidentialInstanceConfig

Optional. Controls Confidential compute options on the instance

Parameter
Name
Description
Returns
Type
Description
$this

getDeletionProtection

Optional. Whether the resource should be protected against deletion.

Returns
Type
Description
bool

hasDeletionProtection

clearDeletionProtection

setDeletionProtection

Optional. Whether the resource should be protected against deletion.

Parameter
Name
Description
var
bool
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

getDisks

Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them.

Returns
Type
Description

setDisks

Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them.

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

getDisplayDevice

Optional. Enables display device for the instance.

Returns
Type
Description

hasDisplayDevice

clearDisplayDevice

setDisplayDevice

Optional. Enables display device for the instance.

Parameter
Name
Description
Returns
Type
Description
$this

getGuestAccelerators

Optional. A list of the type and count of accelerator cards attached to the instance.

Returns
Type
Description

setGuestAccelerators

Optional. A list of the type and count of accelerator cards attached to the instance.

Parameter
Name
Description
var
Returns
Type
Description
$this

getHostname

Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

Returns
Type
Description
string

hasHostname

clearHostname

setHostname

Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInstanceEncryptionKey

Optional. Encrypts suspended data for an instance with a customer-managed encryption key.

Returns
Type
Description

hasInstanceEncryptionKey

clearInstanceEncryptionKey

setInstanceEncryptionKey

Optional. Encrypts suspended data for an instance with a customer-managed encryption key.

Parameter
Name
Description
Returns
Type
Description
$this

getKeyRevocationActionType

Optional. KeyRevocationActionType of the instance.

Returns
Type
Description
int

hasKeyRevocationActionType

clearKeyRevocationActionType

setKeyRevocationActionType

Optional. KeyRevocationActionType of the instance.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getLabels

Optional. Labels to apply to this instance.

Returns
Type
Description

setLabels

Optional. Labels to apply to this instance.

Parameter
Name
Description
Returns
Type
Description
$this

getMachineType

Optional. Full or partial URL of the machine type resource to use for this instance.

Returns
Type
Description
string

hasMachineType

clearMachineType

setMachineType

Optional. Full or partial URL of the machine type resource to use for this instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

Optional. This includes custom metadata and predefined keys.

Returns
Type
Description
Metadata |null

Optional. This includes custom metadata and predefined keys.

Parameter
Name
Description
var
Returns
Type
Description
$this

getMinCpuPlatform

Optional. Minimum CPU platform to use for this instance.

Returns
Type
Description
string

hasMinCpuPlatform

clearMinCpuPlatform

setMinCpuPlatform

Optional. Minimum CPU platform to use for this instance.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNetworkInterfaces

Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

Returns
Type
Description

setNetworkInterfaces

Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

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

getNetworkPerformanceConfig

Optional. Configure network performance such as egress bandwidth tier.

Returns
Type
Description

hasNetworkPerformanceConfig

clearNetworkPerformanceConfig

setNetworkPerformanceConfig

Optional. Configure network performance such as egress bandwidth tier.

Parameter
Name
Description
Returns
Type
Description
$this

getParams

Input only. Additional params passed with the request, but not persisted as part of resource payload.

Returns
Type
Description

hasParams

clearParams

setParams

Input only. Additional params passed with the request, but not persisted as part of resource payload.

Parameter
Name
Description
Returns
Type
Description
$this

getPrivateIpv6GoogleAccess

Optional. The private IPv6 google access type for the VM.

If not specified, use INHERIT_FROM_SUBNETWORK as default.

Returns
Type
Description
int

hasPrivateIpv6GoogleAccess

clearPrivateIpv6GoogleAccess

setPrivateIpv6GoogleAccess

Optional. The private IPv6 google access type for the VM.

If not specified, use INHERIT_FROM_SUBNETWORK as default.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getAllocationAffinity

Optional. Specifies the reservations that this instance can consume from.

Returns
Type
Description

hasAllocationAffinity

clearAllocationAffinity

setAllocationAffinity

Optional. Specifies the reservations that this instance can consume from.

Parameter
Name
Description
Returns
Type
Description
$this

getResourcePolicies

Optional. Resource policies applied to this instance.

Returns
Type
Description

setResourcePolicies

Optional. Resource policies applied to this instance.

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

getScheduling

Optional. Sets the scheduling options for this instance.

Returns
Type
Description
Scheduling |null

hasScheduling

clearScheduling

setScheduling

Optional. Sets the scheduling options for this instance.

Parameter
Name
Description
Returns
Type
Description
$this

getServiceAccounts

Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

Returns
Type
Description

setServiceAccounts

Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.

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

getTags

Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation.

Returns
Type
Description
Tags |null

hasTags

clearTags

setTags

Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation.

Parameter
Name
Description
var
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: