Compute V1 Client - Class InstanceProperties (1.20.0)

Reference documentation and code samples for the Compute V1 Client class InstanceProperties.

Generated from protobuf message google.cloud.compute.v1.InstanceProperties

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ advanced_machine_features Google\Cloud\Compute\V1\AdvancedMachineFeatures

Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
↳ 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 true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.
↳ confidential_instance_config Google\Cloud\Compute\V1\ConfidentialInstanceConfig

Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
↳ description string

An optional text description for the instances that are created from these properties.
↳ disks array<Google\Cloud\Compute\V1\AttachedDisk>

An array of disks that are associated with the instances that are created from these properties.
↳ guest_accelerators array<Google\Cloud\Compute\V1\AcceleratorConfig>

A list of guest accelerator cards' type and count to use for instances created from these properties.
↳ 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 these properties.
↳ machine_type string

The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4. If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4, the request will result in an INTERNAL_ERROR.
↳ metadata Google\Cloud\Compute\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 Project and instance metadata for more information.
↳ 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 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.
↳ network_performance_config Google\Cloud\Compute\V1\NetworkPerformanceConfig

Note that for MachineImage, this is not supported yet.
↳ private_ipv6_google_access string

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. Check the PrivateIpv6GoogleAccess enum for the list of possible values.
↳ reservation_affinity Google\Cloud\Compute\V1\ReservationAffinity

Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
↳ resource_manager_tags array|Google\Protobuf\Internal\MapField

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.
↳ resource_policies array

Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
↳ scheduling Google\Cloud\Compute\V1\Scheduling

Specifies the scheduling options for the instances that are created from these properties.
↳ 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 these properties. Use metadata queries to obtain the access tokens for these instances.
↳ shielded_instance_config Google\Cloud\Compute\V1\ShieldedInstanceConfig

Note that for MachineImage, this is not supported yet.
↳ tags Google\Cloud\Compute\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.

getAdvancedMachineFeatures

Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

Returns
Type Description
Google\Cloud\Compute\V1\AdvancedMachineFeatures|null

hasAdvancedMachineFeatures

clearAdvancedMachineFeatures

setAdvancedMachineFeatures

Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

Parameter
Name Description
var Google\Cloud\Compute\V1\AdvancedMachineFeatures
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 Enable IP forwarding 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 Enable IP forwarding documentation for more information.

Parameter
Name Description
var bool
Returns
Type Description
$this

getConfidentialInstanceConfig

Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

Returns
Type Description
Google\Cloud\Compute\V1\ConfidentialInstanceConfig|null

hasConfidentialInstanceConfig

clearConfidentialInstanceConfig

setConfidentialInstanceConfig

Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

Parameter
Name Description
var Google\Cloud\Compute\V1\ConfidentialInstanceConfig
Returns
Type Description
$this

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

getDisks

An array of disks that are associated with the instances that are created from these properties.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDisks

An array of disks that are associated with the instances that are created from these properties.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\AttachedDisk>
Returns
Type Description
$this

getGuestAccelerators

A list of guest accelerator cards' type and count to use for instances created from these properties.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setGuestAccelerators

A list of guest accelerator cards' type and count to use for instances created from these properties.

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 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

getMachineType

The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4. If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4, the request will result in an INTERNAL_ERROR.

Returns
Type Description
string

hasMachineType

clearMachineType

setMachineType

The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4. If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4, the request will result in an INTERNAL_ERROR.

Parameter
Name Description
var string
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 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 these properties. 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. 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. 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

getNetworkPerformanceConfig

Note that for MachineImage, this is not supported yet.

Returns
Type Description
Google\Cloud\Compute\V1\NetworkPerformanceConfig|null

hasNetworkPerformanceConfig

clearNetworkPerformanceConfig

setNetworkPerformanceConfig

Note that for MachineImage, this is not supported yet.

Parameter
Name Description
var Google\Cloud\Compute\V1\NetworkPerformanceConfig
Returns
Type Description
$this

getPrivateIpv6GoogleAccess

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.

Check the PrivateIpv6GoogleAccess enum for the list of possible values.

Returns
Type Description
string

hasPrivateIpv6GoogleAccess

clearPrivateIpv6GoogleAccess

setPrivateIpv6GoogleAccess

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.

Check the PrivateIpv6GoogleAccess enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getReservationAffinity

Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.

Returns
Type Description
Google\Cloud\Compute\V1\ReservationAffinity|null

hasReservationAffinity

clearReservationAffinity

setReservationAffinity

Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.

Parameter
Name Description
var Google\Cloud\Compute\V1\ReservationAffinity
Returns
Type Description
$this

getResourceManagerTags

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Returns
Type Description
Google\Protobuf\Internal\MapField

setResourceManagerTags

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

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

getResourcePolicies

Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setResourcePolicies

Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.

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

getScheduling

Specifies the scheduling options for the instances that are created from these properties.

Returns
Type Description
Google\Cloud\Compute\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\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 these properties. 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 these properties. 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

getShieldedInstanceConfig

Note that for MachineImage, this is not supported yet.

Returns
Type Description
Google\Cloud\Compute\V1\ShieldedInstanceConfig|null

hasShieldedInstanceConfig

clearShieldedInstanceConfig

setShieldedInstanceConfig

Note that for MachineImage, this is not supported yet.

Parameter
Name Description
var Google\Cloud\Compute\V1\ShieldedInstanceConfig
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.

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

Parameter
Name Description
var Google\Cloud\Compute\V1\Tags
Returns
Type Description
$this