Class: Google::Apis::ComputeBeta::AttachedDiskInitializeParams

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AttachedDiskInitializeParams

Returns a new instance of AttachedDiskInitializeParams.



1841
1842
1843
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1841

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#architecture ⇒ String

The architecture of the attached disk. Valid values are arm64 or x86_64. Corresponds to the JSON property architecture

Returns:

  • (String) 


1668
1669
1670
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1668

def architecture
  @architecture
end

#description ⇒ String

An optional description. Provide this property when creating the disk. Corresponds to the JSON property description

Returns:

  • (String) 


1673
1674
1675
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1673

def description
  @description
end

#disk_name ⇒ String

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created. Corresponds to the JSON property diskName

Returns:

  • (String) 


1681
1682
1683
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1681

def disk_name
  @disk_name
end

#disk_size_gb ⇒ Fixnum

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


1689
1690
1691
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1689

def disk_size_gb
  @disk_size_gb
end

#disk_type ⇒ String

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www. googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www. googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard. Corresponds to the JSON property diskType

Returns:

  • (String) 


1704
1705
1706
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1704

def disk_type
  @disk_type
end

#enable_confidential_compute ⇒ Boolean Also known as: enable_confidential_compute?

Whether this disk is using confidential compute mode. Corresponds to the JSON property enableConfidentialCompute

Returns:

  • (Boolean) 


1709
1710
1711
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1709

def enable_confidential_compute
  @enable_confidential_compute
end

#guest_os_features ⇒ Array<Google::Apis::ComputeBeta::GuestOsFeature>

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures Corresponds to the JSON property guestOsFeatures

Returns:



1718
1719
1720
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1718

def guest_os_features
  @guest_os_features
end

#labels ⇒ Hash<String,String>

Labels to apply to this disk. These can be later modified by the disks. setLabels method. This field is only applicable for persistent disks. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1724
1725
1726
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1724

def labels
  @labels
end

#licenses ⇒ Array<String>

A list of publicly visible licenses. Reserved for Google's use. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


1729
1730
1731
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1729

def licenses
  @licenses
end

#multi_writer ⇒ Boolean Also known as: multi_writer?

Indicates whether or not the disk can be read/write attached to more than one instance. Corresponds to the JSON property multiWriter

Returns:

  • (Boolean) 


1735
1736
1737
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1735

def multi_writer
  @multi_writer
end

#on_update_action ⇒ String

Specifies which action to take on instance update with this disk. Default is to use the existing disk. Corresponds to the JSON property onUpdateAction

Returns:

  • (String) 


1742
1743
1744
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1742

def on_update_action
  @on_update_action
end

#provisioned_iops ⇒ Fixnum

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. Corresponds to the JSON property provisionedIops

Returns:

  • (Fixnum) 


1749
1750
1751
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1749

def provisioned_iops
  @provisioned_iops
end

#provisioned_throughput ⇒ Fixnum

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1. Corresponds to the JSON property provisionedThroughput

Returns:

  • (Fixnum) 


1756
1757
1758
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1756

def provisioned_throughput
  @provisioned_throughput
end

#replica_zones ⇒ Array<String>

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone. Corresponds to the JSON property replicaZones

Returns:

  • (Array<String>) 


1763
1764
1765
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1763

def replica_zones
  @replica_zones
end

#resource_manager_tags ⇒ Hash<String,String>

Resource manager tags to be bound to the disk. 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 formattagValues/456. The field is ignored (both PUT & PATCH) when empty. Corresponds to the JSON propertyresourceManagerTags`

Returns:

  • (Hash<String,String>) 


1771
1772
1773
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1771

def resource_manager_tags
  @resource_manager_tags
end

#resource_policies ⇒ Array<String>

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name. Corresponds to the JSON property resourcePolicies

Returns:

  • (Array<String>) 


1778
1779
1780
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1778

def resource_policies
  @resource_policies
end

#source_image ⇒ String

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks. source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/ debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/ images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my- custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set. Corresponds to the JSON property sourceImage

Returns:

  • (String) 


1795
1796
1797
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1795

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys. Corresponds to the JSON property sourceImageEncryptionKey

Returns:



1804
1805
1806
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1804

def source_image_encryption_key
  @source_image_encryption_key
end

#source_instant_snapshot ⇒ String

The source instant-snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams. sourceInstantSnapshot initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: us-central1-a/ instantSnapshots/my-backup If the source instant-snapshot is deleted later, this field will not be set. Corresponds to the JSON property sourceInstantSnapshot

Returns:

  • (String) 


1815
1816
1817
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1815

def source_instant_snapshot
  @source_instant_snapshot
end

#source_snapshot ⇒ String

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks. source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/ snapshots/my-backup If the source snapshot is deleted later, this field will not be set. Corresponds to the JSON property sourceSnapshot

Returns:

  • (String) 


1825
1826
1827
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1825

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

The customer-supplied encryption key of the source snapshot. Corresponds to the JSON property sourceSnapshotEncryptionKey

Returns:



1830
1831
1832
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1830

def source_snapshot_encryption_key
  @source_snapshot_encryption_key
end

#storage_pool ⇒ String

The storage pool in which the new disk is created. You can provide this as 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 / storagePools/storagePool - projects/project/zones/zone/storagePools/ storagePool - zones/zone/storagePools/storagePool Corresponds to the JSON property storagePool

Returns:

  • (String) 


1839
1840
1841
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1839

def storage_pool
  @storage_pool
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/google/apis/compute_beta/classes.rb', line 1846

def update!(**args)
  @architecture = args[:architecture] if args.key?(:architecture)
  @description = args[:description] if args.key?(:description)
  @disk_name = args[:disk_name] if args.key?(:disk_name)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @disk_type = args[:disk_type] if args.key?(:disk_type)
  @enable_confidential_compute = args[:enable_confidential_compute] if args.key?(:enable_confidential_compute)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @labels = args[:labels] if args.key?(:labels)
  @licenses = args[:licenses] if args.key?(:licenses)
  @multi_writer = args[:multi_writer] if args.key?(:multi_writer)
  @on_update_action = args[:on_update_action] if args.key?(:on_update_action)
  @provisioned_iops = args[:provisioned_iops] if args.key?(:provisioned_iops)
  @provisioned_throughput = args[:provisioned_throughput] if args.key?(:provisioned_throughput)
  @replica_zones = args[:replica_zones] if args.key?(:replica_zones)
  @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @source_image = args[:source_image] if args.key?(:source_image)
  @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key)
  @source_instant_snapshot = args[:source_instant_snapshot] if args.key?(:source_instant_snapshot)
  @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot)
  @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key)
  @storage_pool = args[:storage_pool] if args.key?(:storage_pool)
end