Class: Google::Apis::ComputeAlpha::AttachedDiskInitializeParams

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/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 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.



1606
1607
1608
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1606

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

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


1480
1481
1482
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1480

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) 


1488
1489
1490
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1488

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) 


1496
1497
1498
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1496

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 Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:

Returns:

  • (String) 


1512
1513
1514
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1512

def disk_type
  @disk_type
end

#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::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:



1521
1522
1523
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1521

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


1527
1528
1529
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1527

def labels
  @labels
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) 


1533
1534
1535
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1533

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) 


1540
1541
1542
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1540

def on_update_action
  @on_update_action
end

#provisioned_iops ⇒ Fixnum

Indicates how many IOPS must be provisioned for the disk. Corresponds to the JSON property provisionedIops

Returns:

  • (Fixnum) 


1545
1546
1547
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1545

def provisioned_iops
  @provisioned_iops
end

#replica_zones ⇒ Array<String>

URLs of the zones where the disk should be replicated to. Only applicable for regional resources. Corresponds to the JSON property replicaZones

Returns:

  • (Array<String>) 


1551
1552
1553
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1551

def replica_zones
  @replica_zones
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>) 


1558
1559
1560
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1558

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) 


1579
1580
1581
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1579

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates 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:



1588
1589
1590
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1588

def source_image_encryption_key
  @source_image_encryption_key
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) 


1599
1600
1601
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1599

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



1604
1605
1606
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1604

def source_snapshot_encryption_key
  @source_snapshot_encryption_key
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1611

def update!(**args)
  @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)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @labels = args[:labels] if args.key?(:labels)
  @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)
  @replica_zones = args[:replica_zones] if args.key?(:replica_zones)
  @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_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)
end