Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::InstanceProperties (v2.13.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::InstanceProperties.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#advanced_machine_features

def advanced_machine_features() -> ::Google::Cloud::Compute::V1::AdvancedMachineFeatures

Returns

(::Google::Cloud::Compute::V1::AdvancedMachineFeatures) — Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

#advanced_machine_features=

def advanced_machine_features=(value) -> ::Google::Cloud::Compute::V1::AdvancedMachineFeatures

Parameter

value (::Google::Cloud::Compute::V1::AdvancedMachineFeatures) — Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

Returns

(::Google::Cloud::Compute::V1::AdvancedMachineFeatures) — Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.

#can_ip_forward

def can_ip_forward() -> ::Boolean

Returns

(::Boolean) — 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.

#can_ip_forward=

def can_ip_forward=(value) -> ::Boolean

Parameter

value (::Boolean) — 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

(::Boolean) — 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

def confidential_instance_config() -> ::Google::Cloud::Compute::V1::ConfidentialInstanceConfig

Returns

(::Google::Cloud::Compute::V1::ConfidentialInstanceConfig) — Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

#confidential_instance_config=

def confidential_instance_config=(value) -> ::Google::Cloud::Compute::V1::ConfidentialInstanceConfig

Parameter

value (::Google::Cloud::Compute::V1::ConfidentialInstanceConfig) — Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

Returns

(::Google::Cloud::Compute::V1::ConfidentialInstanceConfig) — Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.

#description

def description() -> ::String

Returns

(::String) — An optional text description for the instances that are created from these properties.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional text description for the instances that are created from these properties.

Returns

(::String) — An optional text description for the instances that are created from these properties.

#disks

def disks() -> ::Array<::Google::Cloud::Compute::V1::AttachedDisk>

Returns

(::Array<::Google::Cloud::Compute::V1::AttachedDisk>) — An array of disks that are associated with the instances that are created from these properties.

#disks=

def disks=(value) -> ::Array<::Google::Cloud::Compute::V1::AttachedDisk>

Parameter

value (::Array<::Google::Cloud::Compute::V1::AttachedDisk>) — An array of disks that are associated with the instances that are created from these properties.

Returns

(::Array<::Google::Cloud::Compute::V1::AttachedDisk>) — An array of disks that are associated with the instances that are created from these properties.

#guest_accelerators

def guest_accelerators() -> ::Array<::Google::Cloud::Compute::V1::AcceleratorConfig>

Returns

(::Array<::Google::Cloud::Compute::V1::AcceleratorConfig>) — A list of guest accelerator cards' type and count to use for instances created from these properties.

#guest_accelerators=

def guest_accelerators=(value) -> ::Array<::Google::Cloud::Compute::V1::AcceleratorConfig>

Parameter

value (::Array<::Google::Cloud::Compute::V1::AcceleratorConfig>) — A list of guest accelerator cards' type and count to use for instances created from these properties.

Returns

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

def key_revocation_action_type() -> ::String

Returns

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

#key_revocation_action_type=

def key_revocation_action_type=(value) -> ::String

Parameter

value (::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.

Returns

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

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — Labels to apply to instances that are created from these properties.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to instances that are created from these properties.

Returns

(::Google::Protobuf::Map{::String => ::String}) — Labels to apply to instances that are created from these properties.

#machine_type

def machine_type() -> ::String

Returns

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

#machine_type=

def machine_type=(value) -> ::String

Parameter

value (::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.

Returns

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

def metadata() -> ::Google::Cloud::Compute::V1::Metadata

Returns

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

#metadata=

def metadata=(value) -> ::Google::Cloud::Compute::V1::Metadata

Parameter

value (::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.

Returns

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

def min_cpu_platform() -> ::String

Returns

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

#min_cpu_platform=

def min_cpu_platform=(value) -> ::String

Parameter

value (::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.

Returns

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

def network_interfaces() -> ::Array<::Google::Cloud::Compute::V1::NetworkInterface>

Returns

(::Array<::Google::Cloud::Compute::V1::NetworkInterface>) — An array of network access configurations for this interface.

#network_interfaces=

def network_interfaces=(value) -> ::Array<::Google::Cloud::Compute::V1::NetworkInterface>

Parameter

value (::Array<::Google::Cloud::Compute::V1::NetworkInterface>) — An array of network access configurations for this interface.

Returns

(::Array<::Google::Cloud::Compute::V1::NetworkInterface>) — An array of network access configurations for this interface.

#network_performance_config

def network_performance_config() -> ::Google::Cloud::Compute::V1::NetworkPerformanceConfig

Returns

(::Google::Cloud::Compute::V1::NetworkPerformanceConfig) — Note that for MachineImage, this is not supported yet.

#network_performance_config=

def network_performance_config=(value) -> ::Google::Cloud::Compute::V1::NetworkPerformanceConfig

Parameter

value (::Google::Cloud::Compute::V1::NetworkPerformanceConfig) — Note that for MachineImage, this is not supported yet.

Returns

(::Google::Cloud::Compute::V1::NetworkPerformanceConfig) — Note that for MachineImage, this is not supported yet.

#private_ipv6_google_access

def private_ipv6_google_access() -> ::String

Returns

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

#private_ipv6_google_access=

def private_ipv6_google_access=(value) -> ::String

Parameter

value (::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.

Returns

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

def reservation_affinity() -> ::Google::Cloud::Compute::V1::ReservationAffinity

Returns

(::Google::Cloud::Compute::V1::ReservationAffinity) — Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.

#reservation_affinity=

def reservation_affinity=(value) -> ::Google::Cloud::Compute::V1::ReservationAffinity

Parameter

value (::Google::Cloud::Compute::V1::ReservationAffinity) — Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.

Returns

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

def resource_manager_tags() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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_manager_tags=

def resource_manager_tags=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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

(::Google::Protobuf::Map{::String => ::String}) — 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

def resource_policies() -> ::Array<::String>

Returns

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

#resource_policies=

def resource_policies=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.

Returns

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

#scheduling

def scheduling() -> ::Google::Cloud::Compute::V1::Scheduling

Returns

(::Google::Cloud::Compute::V1::Scheduling) — Specifies the scheduling options for the instances that are created from these properties.

#scheduling=

def scheduling=(value) -> ::Google::Cloud::Compute::V1::Scheduling

Parameter

value (::Google::Cloud::Compute::V1::Scheduling) — Specifies the scheduling options for the instances that are created from these properties.

Returns

(::Google::Cloud::Compute::V1::Scheduling) — Specifies the scheduling options for the instances that are created from these properties.

#service_accounts

def service_accounts() -> ::Array<::Google::Cloud::Compute::V1::ServiceAccount>

Returns

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

#service_accounts=

def service_accounts=(value) -> ::Array<::Google::Cloud::Compute::V1::ServiceAccount>

Parameter

value (::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.

Returns

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

def shielded_instance_config() -> ::Google::Cloud::Compute::V1::ShieldedInstanceConfig

Returns

(::Google::Cloud::Compute::V1::ShieldedInstanceConfig) — Note that for MachineImage, this is not supported yet.

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Compute::V1::ShieldedInstanceConfig

Parameter

value (::Google::Cloud::Compute::V1::ShieldedInstanceConfig) — Note that for MachineImage, this is not supported yet.

Returns

(::Google::Cloud::Compute::V1::ShieldedInstanceConfig) — Note that for MachineImage, this is not supported yet.

#tags

def tags() -> ::Google::Cloud::Compute::V1::Tags

Returns

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

#tags=

def tags=(value) -> ::Google::Cloud::Compute::V1::Tags

Parameter

value (::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.

Returns

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