Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::SourceInstanceProperties (v2.5.0)

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

DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#can_ip_forward

def can_ip_forward() -> ::Boolean

Returns

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

#can_ip_forward=

def can_ip_forward=(value) -> ::Boolean

Parameter

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

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

def deletion_protection() -> ::Boolean

Returns

(::Boolean) — Whether the instance created from this machine image should be protected against deletion.

#deletion_protection=

def deletion_protection=(value) -> ::Boolean

Parameter

value (::Boolean) — Whether the instance created from this machine image should be protected against deletion.

Returns

(::Boolean) — Whether the instance created from this machine image should be protected against deletion.

#description

def description() -> ::String

Returns

(::String) — An optional text description for the instances that are created from this machine image.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional text description for the instances that are created from this machine image.

Returns

(::String) — An optional text description for the instances that are created from this machine image.

#disks

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

Returns

(::Array<::Google::Cloud::Compute::V1::SavedAttachedDisk>) — An array of disks that are associated with the instances that are created from this machine image.

#disks=

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

Parameter

value (::Array<::Google::Cloud::Compute::V1::SavedAttachedDisk>) — An array of disks that are associated with the instances that are created from this machine image.

Returns

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

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 this machine image.

#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 this machine image.

Returns

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

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 this machine image.

#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 this machine image.

Returns

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

#machine_type

def machine_type() -> ::String

Returns

(::String) — The machine type to use for instances that are created from this machine image.

#machine_type=

def machine_type=(value) -> ::String

Parameter

value (::String) — The machine type to use for instances that are created from this machine image.

Returns

(::String) — The machine type to use for instances that are created from this machine image.

#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 this machine image. 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 this machine image. 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 this machine image. 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 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.

#min_cpu_platform=

def min_cpu_platform=(value) -> ::String

Parameter

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

Returns

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

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.

#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 this machine image.

#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 this machine image.

Returns

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

#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 this machine image. 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 this machine image. 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 this machine image. Use metadata queries to obtain the access tokens for these instances.

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

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

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