Reference documentation and code samples for the Compute V1 Client class SourceInstanceProperties.
DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.
Generated from protobuf message google.cloud.compute.v1.SourceInstanceProperties
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ can_ip_forward |
bool
Enables instances created based on this machine image 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 Enable IP forwarding documentation for more information. |
↳ deletion_protection |
bool
Whether the instance created from this machine image should be protected against deletion. |
↳ description |
string
An optional text description for the instances that are created from this machine image. |
↳ disks |
array<Google\Cloud\Compute\V1\SavedAttachedDisk>
An array of disks that are associated with the instances that are created from this machine image. |
↳ guest_accelerators |
array<Google\Cloud\Compute\V1\AcceleratorConfig>
A list of guest accelerator cards' type and count to use for instances created from this machine image. |
↳ key_revocation_action_type |
string
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels to apply to instances that are created from this machine image. |
↳ machine_type |
string
The machine type to use for instances that are created from this machine image. |
↳ metadata |
Google\Cloud\Compute\V1\Metadata
The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. |
↳ min_cpu_platform |
string
Minimum cpu/platform to be used by instances created from this machine image. 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 Specifying a Minimum CPU Platform. |
↳ network_interfaces |
array<Google\Cloud\Compute\V1\NetworkInterface>
An array of network access configurations for this interface. |
↳ scheduling |
Google\Cloud\Compute\V1\Scheduling
Specifies the scheduling options for the instances that are created from this machine image. |
↳ service_accounts |
array<Google\Cloud\Compute\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 this machine image. Use metadata queries to obtain the access tokens for these instances. |
↳ tags |
Google\Cloud\Compute\V1\Tags
A list of tags to apply to the instances that are created from this machine image. 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. |
getCanIpForward
Enables instances created based on this machine image 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 Enable IP forwarding documentation for more information.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasCanIpForward
clearCanIpForward
setCanIpForward
Enables instances created based on this machine image 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 Enable IP forwarding documentation for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeletionProtection
Whether the instance created from this machine image should be protected against deletion.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasDeletionProtection
clearDeletionProtection
setDeletionProtection
Whether the instance created from this machine image should be protected against deletion.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
An optional text description for the instances that are created from this machine image.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
An optional text description for the instances that are created from this machine image.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisks
An array of disks that are associated with the instances that are created from this machine image.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDisks
An array of disks that are associated with the instances that are created from this machine image.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\SavedAttachedDisk>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGuestAccelerators
A list of guest accelerator cards' type and count to use for instances created from this machine image.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setGuestAccelerators
A list of guest accelerator cards' type and count to use for instances created from this machine image.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\AcceleratorConfig>
|
| 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.
Check the KeyRevocationActionType enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasKeyRevocationActionType
clearKeyRevocationActionType
setKeyRevocationActionType
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
Check the KeyRevocationActionType enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Labels to apply to instances that are created from this machine image.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
Labels to apply to instances that are created from this machine image.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMachineType
The machine type to use for instances that are created from this machine image.
| Returns | |
|---|---|
| Type | Description |
string | |
hasMachineType
clearMachineType
setMachineType
The machine type to use for instances that are created from this machine image.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Metadata|null | |
hasMetadata
clearMetadata
setMetadata
The metadata key/value pairs to assign to instances that are created from this machine image. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\Metadata
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinCpuPlatform
Minimum cpu/platform to be used by instances created from this machine image. 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 Specifying a Minimum CPU Platform.
| Returns | |
|---|---|
| Type | Description |
string | |
hasMinCpuPlatform
clearMinCpuPlatform
setMinCpuPlatform
Minimum cpu/platform to be used by instances created from this machine image. 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 Specifying a Minimum CPU Platform.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworkInterfaces
An array of network access configurations for this interface.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setNetworkInterfaces
An array of network access configurations for this interface.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\NetworkInterface>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScheduling
Specifies the scheduling options for the instances that are created from this machine image.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Scheduling|null | |
hasScheduling
clearScheduling
setScheduling
Specifies the scheduling options for the instances that are created from this machine image.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\Scheduling
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceAccounts
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setServiceAccounts
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this machine image. Use metadata queries to obtain the access tokens for these instances.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\ServiceAccount>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTags
A list of tags to apply to the instances that are created from this machine image. 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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Tags|null | |
hasTags
clearTags
setTags
A list of tags to apply to the instances that are created from this machine image. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\Tags
|
| Returns | |
|---|---|
| Type | Description |
$this | |