Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class ComputeInstanceBackupProperties.
ComputeInstanceBackupProperties represents Compute Engine instance backup properties.
Generated from protobuf message google.cloud.backupdr.v1.ComputeInstanceBackupProperties
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ description |
string
An optional text description for the instances that are created from these properties. |
↳ tags |
Google\Cloud\BackupDR\V1\Tags
A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). |
↳ machine_type |
string
The machine type to use for instances that are created from these properties. |
↳ can_ip_forward |
bool
Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify |
↳ network_interface |
array<Google\Cloud\BackupDR\V1\NetworkInterface>
An array of network access configurations for this interface. |
↳ disk |
array<Google\Cloud\BackupDR\V1\AttachedDisk>
An array of disks that are associated with the instances that are created from these properties. |
↳ metadata |
Google\Cloud\BackupDR\V1\Metadata
The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information. |
↳ service_account |
array<Google\Cloud\BackupDR\V1\ServiceAccount>
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. |
↳ scheduling |
Google\Cloud\BackupDR\V1\Scheduling
Specifies the scheduling options for the instances that are created from these properties. |
↳ guest_accelerator |
array<Google\Cloud\BackupDR\V1\AcceleratorConfig>
A list of guest accelerator cards' type and count to use for instances created from these properties. |
↳ min_cpu_platform |
string
Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as |
↳ key_revocation_action_type |
int
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. |
↳ source_instance |
string
The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels to apply to instances that are created from these properties. |
getDescription
An optional text description for the instances that are created from these properties.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
An optional text description for the instances that are created from these properties.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTags
A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\Tags|null |
|
hasTags
clearTags
setTags
A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\Tags
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMachineType
The machine type to use for instances that are created from these properties.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMachineType
clearMachineType
setMachineType
The machine type to use for instances that are created from these properties.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCanIpForward
Enables instances created based on these properties to send packets with
source IP addresses other than their own and receive packets with
destination IP addresses other than their own. If these instances will be
used as an IP gateway or it will be set as the next-hop in a Route
resource, specify true. If unsure, leave this set to false. See the
https://cloud.google.com/vpc/docs/using-routes#canipforward
documentation for more information.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasCanIpForward
clearCanIpForward
setCanIpForward
Enables instances created based on these properties to send packets with
source IP addresses other than their own and receive packets with
destination IP addresses other than their own. If these instances will be
used as an IP gateway or it will be set as the next-hop in a Route
resource, specify true. If unsure, leave this set to false. See the
https://cloud.google.com/vpc/docs/using-routes#canipforward
documentation for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworkInterface
An array of network access configurations for this interface.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNetworkInterface
An array of network access configurations for this interface.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BackupDR\V1\NetworkInterface>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisk
An array of disks that are associated with the instances that are created from these properties.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDisk
An array of disks that are associated with the instances that are created from these properties.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BackupDR\V1\AttachedDisk>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetadata
The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\Metadata|null |
|
hasMetadata
clearMetadata
setMetadata
The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\Metadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceAccount
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setServiceAccount
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BackupDR\V1\ServiceAccount>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScheduling
Specifies the scheduling options for the instances that are created from these properties.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BackupDR\V1\Scheduling|null |
|
hasScheduling
clearScheduling
setScheduling
Specifies the scheduling options for the instances that are created from these properties.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BackupDR\V1\Scheduling
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGuestAccelerator
A list of guest accelerator cards' type and count to use for instances created from these properties.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setGuestAccelerator
A list of guest accelerator cards' type and count to use for instances created from these properties.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BackupDR\V1\AcceleratorConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinCpuPlatform
Minimum cpu/platform to be used by instances. The instance may be
scheduled on the specified or newer cpu/platform. Applicable values are the
friendly names of CPU platforms, such as
minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge.
For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMinCpuPlatform
clearMinCpuPlatform
setMinCpuPlatform
Minimum cpu/platform to be used by instances. The instance may be
scheduled on the specified or newer cpu/platform. Applicable values are the
friendly names of CPU platforms, such as
minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge.
For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeyRevocationActionType
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasKeyRevocationActionType
clearKeyRevocationActionType
setKeyRevocationActionType
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceInstance
The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSourceInstance
clearSourceInstance
setSourceInstance
The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Labels to apply to instances that are created from these properties.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Labels to apply to instances that are created from these properties.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|