Skip to main content

AttachedDiskInitializeParams

Struct AttachedDiskInitializeParams 

Source
#[non_exhaustive]
pub struct AttachedDiskInitializeParams {
Show 19 fields pub architecture: Option<Architecture>, pub description: Option<String>, pub disk_name: Option<String>, pub disk_size_gb: Option<i64>, pub disk_type: Option<String>, pub enable_confidential_compute: Option<bool>, pub labels: HashMap<String, String>, pub licenses: Vec<String>, pub on_update_action: Option<OnUpdateAction>, pub provisioned_iops: Option<i64>, pub provisioned_throughput: Option<i64>, pub replica_zones: Vec<String>, pub resource_manager_tags: HashMap<String, String>, pub resource_policies: Vec<String>, pub source_image: Option<String>, pub source_image_encryption_key: Option<CustomerEncryptionKey>, pub source_snapshot: Option<String>, pub source_snapshot_encryption_key: Option<CustomerEncryptionKey>, pub storage_pool: Option<String>, /* private fields */
}
Available on crate features instance-templates or instances or machine-images or region-instance-templates or region-instances only.
Expand description

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

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§architecture: Option<Architecture>

The architecture of the attached disk. Valid values are arm64 or x86_64.

§description: Option<String>

An optional description. Provide this property when creating the disk.

§disk_name: Option<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.

§disk_size_gb: Option<i64>

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.

§disk_type: Option<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, seePersistent 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.

§enable_confidential_compute: Option<bool>

Whether this disk is using confidential compute mode.

§labels: HashMap<String, String>

Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for persistent disks.

§licenses: Vec<String>

A list of publicly visible licenses. Reserved for Google’s use.

§on_update_action: Option<OnUpdateAction>

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

§provisioned_iops: Option<i64>

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 theExtreme persistent disk documentation.

§provisioned_throughput: Option<i64>

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.

§replica_zones: Vec<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.

§resource_manager_tags: HashMap<String, String>

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/456 or in namespaced format such as {org_id|project_id}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.

§resource_policies: Vec<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.

§source_image: Option<String>

The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source is required.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specifyfamily/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.

§source_image_encryption_key: Option<CustomerEncryptionKey>

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

§source_snapshot: Option<String>

The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source is required.

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.

Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the bulk insert method.

§source_snapshot_encryption_key: Option<CustomerEncryptionKey>

Thecustomer-supplied encryption key of the source snapshot.

§storage_pool: Option<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

Implementations§

Source§

impl AttachedDiskInitializeParams

Source

pub fn new() -> Self

Source

pub fn set_architecture<T>(self, v: T) -> Self
where T: Into<Architecture>,

Sets the value of architecture.

§Example
use google_cloud_compute_v1::model::attached_disk_initialize_params::Architecture;
let x0 = AttachedDiskInitializeParams::new().set_architecture(Architecture::Arm64);
let x1 = AttachedDiskInitializeParams::new().set_architecture(Architecture::X8664);
Source

pub fn set_or_clear_architecture<T>(self, v: Option<T>) -> Self
where T: Into<Architecture>,

Sets or clears the value of architecture.

§Example
use google_cloud_compute_v1::model::attached_disk_initialize_params::Architecture;
let x0 = AttachedDiskInitializeParams::new().set_or_clear_architecture(Some(Architecture::Arm64));
let x1 = AttachedDiskInitializeParams::new().set_or_clear_architecture(Some(Architecture::X8664));
let x_none = AttachedDiskInitializeParams::new().set_or_clear_architecture(None::<Architecture>);
Source

pub fn set_description<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of description.

§Example
let x = AttachedDiskInitializeParams::new().set_description("example");
Source

pub fn set_or_clear_description<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of description.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_description(Some("example"));
let x = AttachedDiskInitializeParams::new().set_or_clear_description(None::<String>);
Source

pub fn set_disk_name<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of disk_name.

§Example
let x = AttachedDiskInitializeParams::new().set_disk_name("example");
Source

pub fn set_or_clear_disk_name<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of disk_name.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_disk_name(Some("example"));
let x = AttachedDiskInitializeParams::new().set_or_clear_disk_name(None::<String>);
Source

pub fn set_disk_size_gb<T>(self, v: T) -> Self
where T: Into<i64>,

Sets the value of disk_size_gb.

§Example
let x = AttachedDiskInitializeParams::new().set_disk_size_gb(42);
Source

pub fn set_or_clear_disk_size_gb<T>(self, v: Option<T>) -> Self
where T: Into<i64>,

Sets or clears the value of disk_size_gb.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_disk_size_gb(Some(42));
let x = AttachedDiskInitializeParams::new().set_or_clear_disk_size_gb(None::<i32>);
Source

pub fn set_disk_type<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of disk_type.

§Example
let x = AttachedDiskInitializeParams::new().set_disk_type("example");
Source

pub fn set_or_clear_disk_type<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of disk_type.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_disk_type(Some("example"));
let x = AttachedDiskInitializeParams::new().set_or_clear_disk_type(None::<String>);
Source

pub fn set_enable_confidential_compute<T>(self, v: T) -> Self
where T: Into<bool>,

Sets the value of enable_confidential_compute.

§Example
let x = AttachedDiskInitializeParams::new().set_enable_confidential_compute(true);
Source

pub fn set_or_clear_enable_confidential_compute<T>(self, v: Option<T>) -> Self
where T: Into<bool>,

Sets or clears the value of enable_confidential_compute.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_enable_confidential_compute(Some(false));
let x = AttachedDiskInitializeParams::new().set_or_clear_enable_confidential_compute(None::<bool>);
Source

pub fn set_labels<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

§Example
let x = AttachedDiskInitializeParams::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);
Source

pub fn set_licenses<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of licenses.

§Example
let x = AttachedDiskInitializeParams::new().set_licenses(["a", "b", "c"]);
Source

pub fn set_on_update_action<T>(self, v: T) -> Self
where T: Into<OnUpdateAction>,

Sets the value of on_update_action.

§Example
use google_cloud_compute_v1::model::attached_disk_initialize_params::OnUpdateAction;
let x0 = AttachedDiskInitializeParams::new().set_on_update_action(OnUpdateAction::RecreateDiskIfSourceChanged);
let x1 = AttachedDiskInitializeParams::new().set_on_update_action(OnUpdateAction::UseExistingDisk);
Source

pub fn set_or_clear_on_update_action<T>(self, v: Option<T>) -> Self
where T: Into<OnUpdateAction>,

Sets or clears the value of on_update_action.

§Example
use google_cloud_compute_v1::model::attached_disk_initialize_params::OnUpdateAction;
let x0 = AttachedDiskInitializeParams::new().set_or_clear_on_update_action(Some(OnUpdateAction::RecreateDiskIfSourceChanged));
let x1 = AttachedDiskInitializeParams::new().set_or_clear_on_update_action(Some(OnUpdateAction::UseExistingDisk));
let x_none = AttachedDiskInitializeParams::new().set_or_clear_on_update_action(None::<OnUpdateAction>);
Source

pub fn set_provisioned_iops<T>(self, v: T) -> Self
where T: Into<i64>,

Sets the value of provisioned_iops.

§Example
let x = AttachedDiskInitializeParams::new().set_provisioned_iops(42);
Source

pub fn set_or_clear_provisioned_iops<T>(self, v: Option<T>) -> Self
where T: Into<i64>,

Sets or clears the value of provisioned_iops.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_provisioned_iops(Some(42));
let x = AttachedDiskInitializeParams::new().set_or_clear_provisioned_iops(None::<i32>);
Source

pub fn set_provisioned_throughput<T>(self, v: T) -> Self
where T: Into<i64>,

Sets the value of provisioned_throughput.

§Example
let x = AttachedDiskInitializeParams::new().set_provisioned_throughput(42);
Source

pub fn set_or_clear_provisioned_throughput<T>(self, v: Option<T>) -> Self
where T: Into<i64>,

Sets or clears the value of provisioned_throughput.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_provisioned_throughput(Some(42));
let x = AttachedDiskInitializeParams::new().set_or_clear_provisioned_throughput(None::<i32>);
Source

pub fn set_replica_zones<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of replica_zones.

§Example
let x = AttachedDiskInitializeParams::new().set_replica_zones(["a", "b", "c"]);
Source

pub fn set_resource_manager_tags<T, K, V>(self, v: T) -> Self
where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of resource_manager_tags.

§Example
let x = AttachedDiskInitializeParams::new().set_resource_manager_tags([
    ("key0", "abc"),
    ("key1", "xyz"),
]);
Source

pub fn set_resource_policies<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of resource_policies.

§Example
let x = AttachedDiskInitializeParams::new().set_resource_policies(["a", "b", "c"]);
Source

pub fn set_source_image<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of source_image.

§Example
let x = AttachedDiskInitializeParams::new().set_source_image("example");
Source

pub fn set_or_clear_source_image<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of source_image.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_source_image(Some("example"));
let x = AttachedDiskInitializeParams::new().set_or_clear_source_image(None::<String>);
Source

pub fn set_source_image_encryption_key<T>(self, v: T) -> Self

Sets the value of source_image_encryption_key.

§Example
use google_cloud_compute_v1::model::CustomerEncryptionKey;
let x = AttachedDiskInitializeParams::new().set_source_image_encryption_key(CustomerEncryptionKey::default()/* use setters */);
Source

pub fn set_or_clear_source_image_encryption_key<T>(self, v: Option<T>) -> Self

Sets or clears the value of source_image_encryption_key.

§Example
use google_cloud_compute_v1::model::CustomerEncryptionKey;
let x = AttachedDiskInitializeParams::new().set_or_clear_source_image_encryption_key(Some(CustomerEncryptionKey::default()/* use setters */));
let x = AttachedDiskInitializeParams::new().set_or_clear_source_image_encryption_key(None::<CustomerEncryptionKey>);
Source

pub fn set_source_snapshot<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of source_snapshot.

§Example
let x = AttachedDiskInitializeParams::new().set_source_snapshot("example");
Source

pub fn set_or_clear_source_snapshot<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of source_snapshot.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_source_snapshot(Some("example"));
let x = AttachedDiskInitializeParams::new().set_or_clear_source_snapshot(None::<String>);
Source

pub fn set_source_snapshot_encryption_key<T>(self, v: T) -> Self

Sets the value of source_snapshot_encryption_key.

§Example
use google_cloud_compute_v1::model::CustomerEncryptionKey;
let x = AttachedDiskInitializeParams::new().set_source_snapshot_encryption_key(CustomerEncryptionKey::default()/* use setters */);
Source

pub fn set_or_clear_source_snapshot_encryption_key<T>( self, v: Option<T>, ) -> Self

Sets or clears the value of source_snapshot_encryption_key.

§Example
use google_cloud_compute_v1::model::CustomerEncryptionKey;
let x = AttachedDiskInitializeParams::new().set_or_clear_source_snapshot_encryption_key(Some(CustomerEncryptionKey::default()/* use setters */));
let x = AttachedDiskInitializeParams::new().set_or_clear_source_snapshot_encryption_key(None::<CustomerEncryptionKey>);
Source

pub fn set_storage_pool<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of storage_pool.

§Example
let x = AttachedDiskInitializeParams::new().set_storage_pool("example");
Source

pub fn set_or_clear_storage_pool<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of storage_pool.

§Example
let x = AttachedDiskInitializeParams::new().set_or_clear_storage_pool(Some("example"));
let x = AttachedDiskInitializeParams::new().set_or_clear_storage_pool(None::<String>);

Trait Implementations§

Source§

impl Clone for AttachedDiskInitializeParams

Source§

fn clone(&self) -> AttachedDiskInitializeParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AttachedDiskInitializeParams

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for AttachedDiskInitializeParams

Source§

fn default() -> AttachedDiskInitializeParams

Returns the “default value” for a type. Read more
Source§

impl Message for AttachedDiskInitializeParams

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for AttachedDiskInitializeParams

Source§

fn eq(&self, other: &AttachedDiskInitializeParams) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for AttachedDiskInitializeParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,